Create a Link account

Path Params

• enterpriseId string required
  Your enterprise id.

  at least 1 characters · matches ^[0-9a-f]{32}$

Header Params

• user-id string required
  User id of the user making the request.

  at least 1 characters

Body Params

object

• 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.

  at least 1 characters
• credentials array of objects required
  credentials object

  • accessLevels array of string enums required
    read_write
    read_write ×

    + Add item
  • wrappedKey string required

    at least 1 characters
  • iv string required

    at least 1 characters
  • tag string required

    at least 1 characters
  • masterKeyVersion number required
  • credentials string required

    at least 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.

  at least 1 characters
• description string required
  An optional description for the account. This can be any string and is not required to be unique.

  at least 1 characters
• whitelistingEnabled boolean
  Optional flag to indicate if whitelisting is enabled on the venue. This means withdrawals can only happen to previously whitelisted addresses.
  False True
• 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.

Responses