List whitelisted addresses

get

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

This endpoint returns a list of whitelisted addresses

Query Params

limit

string

uint64; Return maximum limit items for a query; Max 100.

offset

string

uint64; Start retrieving items starting at offset id

exchangeAccountId

string

uint64; Deprecated: Use exchangeAccountIds instead

addressType

string

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

query

string

Will find a match in any part of the value. Filter applies to the following fields: customerid, address, blockchain, label, memo, addresstype

currency

string

Deprecated: Use blockchain instead

scoreProvider

string

Deprecated: Use scoreFilter instead. Can be either of the following: scorechain, coinfirm, chainalysis, elliptic, trmlabs

scoreInBelow

string

numeric; Deprecated: Use scoreFilter instead

scoreOutBelow

string

numeric; Deprecated: Use scoreFilter instead

scoreExclusive

boolean

Deprecated: Use scoreFilter instead

rulesContainerNormalized

boolean

Normalize rules containers in its own object

exchangeAccountIds

array of strings

uint64; Array containing the list of IDs for exchange accounts

exchangeAccountIds

coinfirmScoreGreater

string

uint64; Deprecated: Use scoreFilter instead

tagIDs

array of strings

Filter addresses with a 'OR' combination of tag IDs

tagIDs

chainalysisScoreGreater

string

uint64; Deprecated: Use scoreFilter instead

contractType

string

Deprecated: Use contractTypes instead

allowedForAddressId

string

uint64; Filter addresses allowed to receive funds from this address id

allowedForWalletId

string

uint64; Filter addresses allowed to receive funds from this wallet id. Will be ignored if allowedForAddressId is filled

blockchain

string

Filter on the blockchain of the WLA.

includeForApproval

boolean

If true, include also addresses waiting for approval in the results.

addresses

array of strings

Filter on the specific addresses to return. This field is using the blockchain's native address syntax

addresses

network

string

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

ids

array of strings

uint64; List of IDs to return

ids

tnParticipantID

string

uuid; UUID of the Taurus-NETWORK participant to whom the address belongs

scoreFilter.scoreProvider

string

Specify the score provider to filter on, or empty.Each provider has associated filter parameters that can be set.Supported values: scorechain, coinfirm, chainalysis, elliptic, trmlabs

scoreFilter.scorechainFilters.scoreInBelow

string

Filter addresses under a Scorechain incoming score threshold.

scoreFilter.scorechainFilters.scoreOutBelow

string

Filter addresses under a Scorechain outgoing score threshold.

scoreFilter.scorechainFilters.scoreExclusive

boolean

By default when both Scorechain scores scoreInBelow and scoreOutBelow are provided, it returns the addresses matching (scoreInBelow AND scoreOutBelow). When scoreExclusive is set to true, it will return the addresses matching (scoreInBelow OR scoreOutBelow).

scoreFilter.coinfirmFilters.scoreGreater

string

Filter addresses with a Coinfirm C-score above threshold.

scoreFilter.chainalysisFilters.scoreGreater

string

Filter addresses with a Chainalysis risk score above threshold.

scoreFilter.ellipticFilters.scoreGreater

string

Filter addresses with an Elliptic risk score above threshold.

scoreFilter.trmlabsFilters.scoreGreater

string

Filter addresses with an TRM Labs risk score above threshold.

lastIncomingTxFromWhitelistedAddress

date-time

Filtered addresses with the last incoming transaction older than lastIncomingTransactionDate won't appear in the result. The default value is never

contractTypes

array of strings

Filter addresses by multiple Contract Types. 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

contractTypes

attributeFiltersJson

string

A JSON representation of a list of AttributeFilter objects. The filters are combined with an attributeFiltersOperator ('OR' by default). Each AttributeFilter can use different comparison operators: = (default if not specified), <> (not equal), > (greater than), >= (greater than or equal), < (less than), <= (less than or equal)

attributeFiltersOperator

string

Specifies how attribute filters are combined. Accepted values: 'OR' (default), 'AND'.

Responses

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

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.