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

post

Whitelist a crypto address.

Authorizations

Body

clientAddressIdstringRequired

Address ID provided by the client.

currencystring · enumRequiredPossible values:

networkstring · enumRequiredPossible values:

addressstringRequired

Crypto address.

destinationTagstringOptional

XLM/XRP destination tag.

labelstringOptional

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

Responses

201

Address was successfully whitelisted.

application/json

post

HTTPcURLJavaScriptPython

POST /api/v1/whitelist-addresses HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 145

{
  "clientAddressId": "Client ID",
  "currency": "ETH",
  "address": "0xcefcca169357a18eb8c3f230f92b58562e48cae5",
  "network": "BSC",
  "label": "Users in Europe"
}

201

Address was successfully whitelisted.

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