Overview

Create a connection to a partner platform, so you can trade assets, custodied at BitGo Bank & Trust, on their platform. In order to activate the partner in your Go Network, you must first have an account on the partner's platform. You can connect with multiple partners and you can also have multiple connections to the same partner.

You can download the BitGo OES Client Postman Collection and import it into Postman to quickly explore and test the OES client APIs.

Prerequisites

  • Get Started
  • Generate an access token and a read-only API key from your account on the partner platform

Cookbook

Need just the steps? Expand the cookbook below to get started:

Connect to PartnersOpen Cookbook

Steps

Endpoint: Connect to Partner

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"
    }
  }'

Step Result

{
  "connection": {
    "createdAt": "2019-08-24",
    "updatedAt": "2019-08-24",
    "partnersConnectionId": "string",
    "partnersClientId": "string",
    "initialized": true,
    "id": "string",
    "name": "string",
    "clientId": "string",
    "partnerId": "string",
    "networkAccountId": "string",
    "active": true,
    "proof": "string",
    "nonce": "string"
  }
}

Next

Allocate Assets

See Also

API Reference: Connect to Partner