Off-Exchange Settlement: Connect to Partners

Create a connection to a partner platform to trade assets custodied at BitGo. See the Guide.

  1. You create a connection to a partner platform so you can trade assets custodied at BitGo Bank & Trust on their platform. You must first have an account on the partner's platform and generate an access token and read-only API key from that account. You can connect with multiple partners and have multiple connections to the same partner.

    Prerequisites: Generate an access token and a read-only API key from your account on the partner platform.

    API Reference

// 1. Create Client Connection
export ACCESS_TOKEN="<YOUR_ACCESS_TOKEN>"
export ENTERPRISE_ID="<YOUR_ENTERPRISE_ID>"

curl -X POST \
  https://app.bitgo-test.com/api/network/v1/enterprises/$ENTERPRISE_ID/clients/connections \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer $ACCESS_TOKEN' \
  -d '{
    "payload": "string",
    "signature": "string",
    "nonce": "string",
    "partnerId": "string",
    "name": "string",
    "connectionKey": {
      "schema": "token",
      "connectionToken": "string"
    }
  }'
Response
// 1. Create Client Connection Response
{
  "connection": {
    "createdAt": "2019-08-24",
    "updatedAt": "2019-08-24",
    "partnersConnectionId": {},
    "partnersClientId": {},
    "initialized": true,
    "id": "string",
    "name": "string",
    "clientId": "string",
    "partnerId": "string",
    "networkAccountId": "string",
    "active": true,
    "proof": "string",
    "nonce": "string"
  }
}