Skip to navigation
Wallets and AddressesAddress whitelisting

Create a whitelisted address

This endpoint creates a new whitelisted address. Required role: WhitelistedAddressCreator.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
addressstringRequired

Required: The address you wish to whitelist. Must be a valid address for the desired blockchain and network.

labelstringRequired

Required: A label to apply to the desired whitelisted address.

blockchainstringRequired

Required: The symbol of the blockchain of which to whitelist an address. (ex. eth, btc)

memostringOptional
A memo to apply to the desired whitelisted address.
exchangeAccountIdstringOptionalformat: "uint64"

uint64; The id of an exchange account. There is a single exchange account per currency, per exchange

customerIdstringOptional
The id of the customer to associate with this address.
linkedInternalAddressIdslist of stringsOptional
uint64 Array, An array of address ids to attach to this address, must match the blockchain of the linked addresses and they must not belong omnibus wallets.
addressTypestringOptional

The type of the address (e.g. individual, exchange, baker, contract, stakepool, validator, node, fiatprovider).

contractTypestringOptional

The type of contract to associate with this address (ex. CMTA20, GENERIC).

linkedWalletIdslist of stringsOptional

uint64 Array; An array of wallets to attach to this address.

networkstringOptional

The network of the blockchain the whitelisted address belongs to (ex. mainnet).

visibilityGroupIDstringOptional
The id of the visibility group to place the address in. You must be able to see this visibility group.
currencystringOptional

Deprecated: use the blockchain parameter instead

Response

A successful response.
resultobjectOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error
503
Service Unavailable Error