Ctrl+K

Add Counterparties

Overview

Grow your Go Network by listing your Go Account in a public directory along with other Go Accounts. Each enterprise in the directory has 1 listing for itself. An enterprise listing can have multiple entries. For example, your Go Account is an entry in your listing.

Find Go Accounts you want to connect with and add them as a counterparty for streamlined settlements and transactions. Counterparty connections are 1-to-1 relationships between two Go Accounts, enabling Settlements with one another.

Prerequisites

Get Started

1. List your Enterprise

List your enterprise in the public directory so that other enterprises can find you and add you as a counterparty.

Endpoint: Create enterprise listing

  • cURL
1
2
3
4
5
6
7
8
export ACCESS_TOKEN="<YOUR_ACCESS_TOKEN>"
export DESCRIPTION="<YOUR_PUBLIC_DESCRIPTION>"

curl -X POST \
  https://app.bitgo-test.com/api/address-book/v1/listing/global \
  -H 'Content-Type: application/json' \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -d '{"description": "'"$DESCRIPTION"'"}'

Step Result

You Enterprise is now discoverable in the public directory.

  • JSON
1
2
3
4
5
6
7
8
9
{
  "id": "string",
  "enterpriseId": "string",
  "description": "string",
  "name": "string",
  "owner": "string",
  "createdAt": "string",
  "updatedAt": "string"
}

2. Create Listing Entry

Create an entry for your Go Account within your enterprise listing. This enables you and others to create connections between your Go Account and theirs.

Endpoint: Create a listing entry for your enterprises Go Account

  • cURL
1
2
3
4
5
6
7
8
9
10
11
12
13
export ACCESS_TOKEN="<YOUR_ACCESS_TOKEN>"
export WALLET_ID="<YOUR_WALLET_ID>"
export DESCRIPTION="<YOUR_PUBLIC_DESCRIPTION>"

curl -X POST \
  https://app.bitgo-test.com/api/address-book/v1/listing/entry/global \
  -H 'Content-Type: application/json' \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -d '{
    "walletId": "'"$WALLET_ID"'",
    "description": "'"$DESCRIPTION"'",
    "public": true
  }'

Step Result

  • JSON
1
2
3
4
5
6
7
8
9
10
11
{
  "id": "string",
  "walletId": "string",
  "coin": "string",
  "type": "GO_ACCOUNT",
  "description": "string",
  "discoverable": true,
  "featured": true,
  "createdAt": "string",
  "updatedAt": "string"
}

3. Add a Connection

Add connections to Go Accounts you find in the directory by passing the targetListingEntryId. If a Go Account isn't listed in the directory, you can still add connection if you know the wallet ID of the partner's Go Account.

Endpoint: Add a Go Account connection

  • cURL (listed)
  • cURL (unlisted)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
export ACCESS_TOKEN="<YOUR_ACCESS_TOKEN>"
export LISTING_ENTRY_ID="<LISTING_ENTRY_ID>"
export LOCAL_LISTING_ENTRY_DESCRIPTION="<LOCAL_LISTING_ENTRY_DESCRIPTION>"
export TARGET_LISTING_ENTRY_ID="<TARGET_LISTING_ENTRY_ID>"

curl -X POST \
  https://app.bitgo-test.com/api/address-book/v1/connections \
  -H 'Content-Type: application/json' \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -d '{
    "listingEntryId": "'"$LISTING_ENTRY_ID"'",
    "localListingEntryDescription": "'"$LOCAL_LISTING_ENTRY_DESCRIPTION"'",
    "targetListingEntryId": "'"$TARGET_LISTING_ENTRY_ID"'"
  }'

Step Result

  • JSON
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
{
  "connections": [
    {
      "ownerListingEntry": {
        "listing": {
          "id": "string",
          "name": "string",
          "description": "string",
          "editable": true
        },
        "id": "string",
        "walletId": "string",
        "coin": "string",
        "type": "GO_ACCOUNT",
        "description": "string",
        "discoverable": true,
        "featured": true,
        "createdAt": "string",
        "updatedAt": "string"
      },
      "targetListingEntry": {
        "listing": {
          "id": "string",
          "name": "string",
          "description": "string",
          "editable": true
        },
        "id": "string",
        "walletId": "string",
        "coin": "string",
        "type": "GO_ACCOUNT",
        "description": "string",
        "discoverable": true,
        "featured": true,
        "createdAt": "string",
        "updatedAt": "string"
      },
      "id": "string", // this is the addressBookConnectionId for settlements
      "type": "DVP",
      "status": "PENDING_DEACTIVATION",
      "label": "string",
      "description": "string",
      "createdBy": "string",
      "updatedBy": "string",
      "createdAt": "string",
      "updatedAt": "string" // this is the addressBookConnectionUpdatedAt for settlements
    }
  ]
}

Next Steps

Settlements

See Also