Whitelisting addresses

In most cases, when you are sending cryptocurrency to an external wallet, you want to make sure that you are sending the funds to the right crypto address.

Whitelist an address

Whitelist a crypto address.

post

/api/v1/whitelist-addresses

Authorizations

Body

clientAddressIdstringrequired

Address ID provided by the client.

currencystring · enumrequired

Options: BCH, BTC, ETH, LINK, LTC, SOL, USDC, XLM, XRP

networkstring · enumrequired

Options: BCH, BTC, LTC, XLM, XRP, ETH, BSC, SOL, TRX

addressstringrequired

Crypto address.

destinationTagstring

XLM/XRP destination tag.

labelstring

Label of the address, useful for grouping multiple whitelisted addresses.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/v1/whitelist-addresses' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "clientAddressId": "Client ID",
    "currency": "ETH",
    "address": "0xcefcca169357a18eb8c3f230f92b58562e48cae5",
    "network": "BSC",
    "label": "Users in Europe"
  }'

201

201

{
  "id": "6b6ae97a-d6af-4752-8629-7e9485618df2",
  "clientAddressId": "Client ID",
  "currency": "ETH",
  "network": "BSC",
  "address": "0xcefcca169357a18eb8c3f230f92b58562e48cae5",
  "label": "Users in Europe",
  "createdAt": 1702990609,
}

Address was successfully whitelisted.