Get account information

post/venue-adapter-service/api/vas/v1/account-information

Returns credential account details and related accounts, used by Link.

Request Body

credentialExternalId string
CMS credential external ID; either this or credentialData must be supplied
Min length: >= 1 characters
credentialData object
Encrypted credential payload; either this or credentialExternalId must be supplied
encryptedCredentials string required
Encrypted credentials as a single base64-encoded blob
Min length: >= 1 characters
iv string required
Initialization vector for credential encryption
Min length: >= 1 characters
masterKeyVersion number required
Version of the master key used for wrapping
tag string required
Authentication tag for credential encryption
Min length: >= 1 characters
venueIdOne ofrequired
Venue identifier for the credentials
Allowed values: BITGET BITGET_PROD COINBASE_EXCHANGE COINBASE_EXCHANGE_PROD CRYPTOCOM CRYPTOCOM_PROD DERIBIT DERIBIT_PROD GATE GATE_PROD HTX HTX_PROD KRAKEN_SPOT KRAKEN_SPOT_PROD KUCOIN KUCOIN_PROD OKX OKX_PROD
wrappedKey string required
Wrapped symmetric key used to encrypt credentials
Min length: >= 1 characters
parentCredentialExternalId string
CMS credential external ID for the parent account; used to verify sub-account relationships
Min length: >= 1 characters

200 Response

credentialAccount object
externalAccountId string required
Min length: >= 1 characters
isMainAccount boolean
relatedAccounts array[object]
externalAccountId string required
Min length: >= 1 characters
isMainAccount boolean

400 Response

errorName string required
error string required

404 Response

errorName string required
error string required

409 Response

errorName string required
error string required

422 Response

errorName string required
error string required

500 Response

errorName string required
error string required