v1

latestOpenAPI 3.1.02026-07-26165182724.7 KB

Whitelist Destination Address

Whitelist a destination address for a user

post/wallets/whitelist-address

Headers

api-keystring required

api-key is available on the dashboard

Authorizationstring required

Request body

userIdstring required

The Id of the user who is sending this transaction

addressstring required

A string of the destination. Must be a valid address on the network you want to whitelist for.

currencystring required

The currency you want this whitelisted address to receive.

networkstring required

A network from the default networks specified in the "Moving Money Around" section

labelstring

An optional label to tag your address. Must be unique. A string upto 30 characters.

Response

200

idstring

statusstring

addressstring

currencystring

labelstring

internalboolean

internalAccountIdstring

Example response

{
  "id": "dd506137-219b-412b-968c-bf0338e14e56",
  "status": "PENDING_ACTIVATION",
  "address": "bc1qkkn40ltka0rsa8l290lwp49ywmyfw6n5vzat32",
  "currency": "BTC",
  "label": "RA BTC",
  "network": {
    "name": "Bitcoin",
    "network": "Bitcoin"
  },
  "internal": true,
  "internalAccountId": "ac17191c0ae181cecf24375c6ba4feab"
}