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

Authorization

ApiKeyAuth

Body

application/json

clientAddressId*string

Address ID provided by the client.

currency*enum

BCHBTCETHLINKLTCSOLUSDCXLMXRP

network*enum

BCHBTCLTCXLMXRPETHBSCSOLTRX

address*string

Crypto address.

destinationTagstring

XLM/XRP destination tag.

labelstring

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

Response

201

Address was successfully whitelisted.

Body

application/json

id*string (uuid)

Address ID.

clientAddressId*string

Address ID provided by the client.

currency*enum

Address' intended currency.

BCHBTCETHLINKLTCSOLUSDCXLMXRP

network*enum

Blockchain.

BCHBTCLTCXLMXRPETHBSCSOLTRX

address*string

Crypto address.

destinationTagstring

XLM/XRP destination tag.

labelstring

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

createdAt*integer (int64)

UNIX seconds at which the address was created.

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/whitelist-addresses', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "clientAddressId": "Client ID",
      "currency": "ETH",
      "address": "0xcefcca169357a18eb8c3f230f92b58562e48cae5",
      "network": "BSC",
      "label": "Users in Europe"
    }),
});
const data = await response.json();

Response

201

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "clientAddressId": "text",
  "currency": "BCH",
  "network": "BCH",
  "address": "text",
  "destinationTag": "text",
  "label": "text",
  "createdAt": 0
}