Sign in
Link Accounts

Create a Link account

Creates a new account for the given enterprise at the specified venue.

post/api/link/v1/enterprises/{enterpriseId}/accounts

Path parameters

enterpriseIdstring required
Example:59cd72485007a239fb00282ed480da1f

Your enterprise id.

Headers

user-idstring required

User id of the user making the request.

Request body

venueIdstring required

The venue for which the account is being created. This should be a valid venue identifier returned by the GET /venues endpoint.

namestring required

A unique name for the account. This is used to identify the account in BitGo and must be unique within your enterprise.

descriptionstring required

An optional description for the account. This can be any string and is not required to be unique.

whitelistingEnabledboolean

Optional flag to indicate if whitelisting is enabled on the venue. This means withdrawals can only happen to previously whitelisted addresses.

parentAccountstring

An optional parent account id to link this account to. This is used for sub-accounts under a main account. The parent account must already exist in BitGo.

Example request

{
  "venueId": "COINBASE_EXCHANGE",
  "name": "My Coinbase Account",
  "description": "This account is used for trading on Coinbase.",
  "parentAccount": "aba3a693-4f28-4523-8e53-85a3df22a608"
}

Response

Created

idstring required
venueIdstring required
status'active' | 'inactive' | 'deleted' | 'pending_credentials' | 'restricted' required
namestring required
descriptionstring required
whitelistingEnabledboolean required
parentAccountstring
createdDatestring date-time required
modifiedDatestring date-time required

Changes

Changed in 2 of the 17 revisions of this API.11

  • 37833ced53461See the full diff
    • ●

      added the new restricted enum value to the allOf[subschema #2: V1AccountResponse]/status response property for the response status 201

      response-property-enum-value-added

  • d462b237b9841See the full diff
    • ○

      added the non-success response with the status 404

      response-non-success-status-added