Skip to navigation
Taurus-PROTECT APIsAddress 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
A blockchain address in canonical format.
labelstringRequired
A label to distinguish the address
blockchainstringRequired
Symbol of the blockchain on which to whitelist an address
memostringOptional

For blockchains which support memo tags, such as XLM or XRP, only whitelist for transactions using this value as memo.

exchangeAccountIdstringOptionalformat: "int64"
The ID for the associated exchange account
customerIdstringOptional
An optional string designating a user account. This field can't be used for filtering!
linkedInternalAddressIdslist of stringsOptional

A list of address IDs which are allowed to create requests targeting address

addressTypestringOptional

Can be one of the following: individual, exchange, baker, stakepool, contract, validator, node

contractTypestringOptional

Can be any of: GENERIC, CMTA20, CMTA20-KYC, CMTA20-RULEENGINE, CMTAT, ERC20, DEFI, ERC2771-PROXY-ADMIN, TERC1155A, GSN_FORWARDER, OPEN_ZEPPELIN_FORWARDER, TAURUS_CONTRACT_CREATOR, SMARTPY-FA2, SMARTPY-FA12, ASA, FIGMENT_STAKING

linkedWalletIdslist of stringsOptional

A list of wallet IDs which are allowed to create requests targeting address

networkstringOptional

Name of the blockchain network, eg. mainnet, testnet, or sepolia

visibilityGroupIDstringOptional
External ID of a restricted 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