Create a whitelisted address

post

https://your-protect-instance.example.com/api/rest/v1/whitelists/addresses

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

Body Params

address

string

required

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

memo

string

A memo to apply to the desired whitelisted address.

label

string

required

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

exchangeAccountId

string

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

customerId

string

The id of the customer to associate with this address.

linkedInternalAddressIds

array of strings

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.

linkedInternalAddressIds

addressType

string

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

contractType

string

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

linkedWalletIds

array of strings

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

linkedWalletIds

blockchain

string

required

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

network

string

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

visibilityGroupID

string

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

currency

string

Deprecated: use the blockchain parameter instead

Responses

200A successful response.

400Bad Request: indicates that the server cannot or will not process the request due to something that is perceived to be a client error (for example, malformed request syntax, invalid request message framing, or deceptive request routing)

401Unauthorized: indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource

403Forbidden: indicates that the server understands the request but refuses to authorize it

404Not Found: indicates that the server cannot find the requested resource

500Internal Server Error: indicates that the server encountered an unexpected condition that prevented it from fulfilling the request

503Service Unavailable: indicates that the server is not ready to handle the request.

defaultAn unexpected error response.