Ctrl+K

Create a Link account

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

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

Path Parameters

  • enterpriseIdstringRequired
    Your enterprise id.
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$
    Min length: >= 1 characters

Request Body

venueId string required
The venue for which the account is being created. This should be a valid venue identifier returned by the GET /venues endpoint.
Min length: >= 1 characters
Example: COINBASE_EXCHANGE
credentials array[object] required
An array of credentials to associate with the new account. Each credential should include the access level, encrypted credentials, and envelope encryption fields. See the CredentialInput type for details.
accessLevels array[string] required
Allowed values: read write read_write
wrappedKey string required
Min length: >= 1 characters
iv string required
Min length: >= 1 characters
tag string required
Min length: >= 1 characters
masterKeyVersion number required
credentials string required
Min length: >= 1 characters
expirationDate string <date-time>
name string required
A unique name for the account. This is used to identify the account in BitGo and must be unique within your enterprise.
Min length: >= 1 characters
Example: My Coinbase Account
description string required
An optional description for the account. This can be any string and is not required to be unique.
Min length: >= 1 characters
Example: This account is used for trading on Coinbase.
whitelistingEnabled boolean
Optional flag to indicate if whitelisting is enabled on the venue. This means withdrawals can only happen to previously whitelisted addresses.
Example: false
parentAccount string
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: aba3a693-4f28-4523-8e53-85a3df22a608

201 Response

id string required
venueId string required
Min length: >= 1 characters
credentials array[object] required
id string required
accessLevels array[string] required
Allowed values: read write read_write
expirationDate string
Min length: >= 1 characters
status string required
Allowed values: active inactive deleted pending_credentials
name string required
Min length: >= 1 characters
description string required
Min length: >= 1 characters
whitelistingEnabled boolean required
parentAccount string
users array[object]
permissions array[string] required
Allowed values: link.account.admin link.account.transfer link.account.view
userId string required
Min length: >= 1 characters
createdDate string <date-time>required
modifiedDate string <date-time>required

400 Response

401 Response

errorName string required
error string required

403 Response

errorName string required
error string required

409 Response

errorName string required
error string required

500 Response

errorName string required
error string required