Skip to navigation
Taurus-PROTECT APIsAddress whitelisting

List whitelisted addresses

This endpoint returns a list of whitelisted addresses

Authentication

AuthorizationBearer

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

Query parameters

limitstringOptionalformat: "uint64"

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

offsetstringOptionalformat: "uint64"

uint64; Start retrieving items starting at offset id

exchangeAccountIdstringOptionalformat: "uint64"

uint64; Deprecated: Use exchangeAccountIds instead

addressTypestringOptional

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

querystringOptional

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

currencystringOptional

Deprecated: Use blockchain instead

scoreProviderstringOptional

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

scoreInBelowstringOptional

numeric; Deprecated: Use scoreFilter instead

scoreOutBelowstringOptional

numeric; Deprecated: Use scoreFilter instead

scoreExclusivebooleanOptional

Deprecated: Use scoreFilter instead

rulesContainerNormalizedbooleanOptional

Deprecated: Normalize rules containers in its own object

exchangeAccountIdslist of stringsOptional

uint64; Array containing the list of IDs for exchange accounts

coinfirmScoreGreaterstringOptional

uint64; Deprecated: Use scoreFilter instead

tagIDslist of stringsOptional
Filter addresses with a 'OR' combination of tag IDs
chainalysisScoreGreaterstringOptional

uint64; Deprecated: Use scoreFilter instead

contractTypestringOptional

Deprecated: Use contractTypes instead

allowedForAddressIdstringOptionalformat: "uint64"

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

allowedForWalletIdstringOptionalformat: "uint64"

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

blockchainstringOptional
Filter on the blockchain of the WLA.
includeForApprovalbooleanOptional
If true, include also addresses waiting for approval in the results.
addresseslist of stringsOptional
Filter on the specific addresses to return. This field is using the blockchain's native address syntax
networkstringOptional

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

idslist of stringsOptional

uint64; List of IDs to return

tnParticipantIDstringOptional

uuid; UUID of the Taurus Network participant to whom the address belongs

scoreFilter.scoreProviderstringOptional

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.scoreInBelowstringOptional
Filter addresses under a Scorechain incoming score threshold.
scoreFilter.scorechainFilters.scoreOutBelowstringOptional
Filter addresses under a Scorechain outgoing score threshold.
scoreFilter.scorechainFilters.scoreExclusivebooleanOptional

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.scoreGreaterstringOptional

Filter addresses with a Coinfirm C-score above threshold.

scoreFilter.chainalysisFilters.scoreGreaterstringOptional
Filter addresses with a Chainalysis risk score above threshold.
scoreFilter.ellipticFilters.scoreGreaterstringOptional
Filter addresses with an Elliptic risk score above threshold.
scoreFilter.trmlabsFilters.scoreGreaterstringOptional
Filter addresses with an TRM Labs risk score above threshold.
lastIncomingTxFromWhitelistedAddressdatetimeOptional
Filtered addresses with the last incoming transaction older than lastIncomingTransactionDate won't appear in the result. The default value is never
contractTypeslist of stringsOptional

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

attributeFiltersJsonstringOptional
A JSON representation of a list of AttributeFilter objects. The filters are combined with an OR operator.

Response

A successful response.
resultlist of objectsOptional
totalItemsstringOptionalformat: "uint64"
rulesContainerslist of objectsOptional

Errors

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