Skip to main content
GET
/
v1
/
wallet
/
whitelist
Get Whitelisted Addresses
curl --request GET \
  --url https://api.example.com/v1/wallet/whitelist \
  --header 'Authorization: <authorization>' \
  --header 'x-client-key: <x-client-key>'
[
  {
    "id": "d7ed0d12-270c-4491-b1a4-bebf2cc42b5c",
    "name": "Binance Account | Primary",
    "beneficiaryFirstName": "John",
    "beneficiaryLastName": "Doe",
    "walletAddress": "rNxp4h8apvRis6mJf9Sh8C6iRxfrDWN7AA",
    "walletMemo": "66",
    "currency": "xrp",
    "lastUsedAt": "2025-08-12T13:44:47.287Z",
    "createdAt": "2025-08-11T13:44:47.287Z"
  },
  {
    "id": "a3f2e1d4-c5b6-47a8-9e0f-1d2c3b4a5e6f",
    "name": "Kraken Exchange",
    "beneficiaryFirstName": "John",
    "beneficiaryLastName": "Doe",
    "walletAddress": "rPEPPER7kfTD9w2To4CQk6UCfuHM9c6GDY",
    "walletMemo": "12345",
    "currency": "xrp",
    "lastUsedAt": null,
    "createdAt": "2025-08-10T10:30:22.123Z"
  }
]

Overview

Whitelist management provides an additional security layer for withdrawals from internal (custodial) wallets. Whitelisted addresses are pre-approved withdrawal destinations that have been verified and saved for secure fund transfers. Security Benefits:
  • Pre-approve trusted addresses before withdrawal
  • Prevent withdrawal to unauthorized addresses
  • Maintain audit trail of approved destinations
  • Track usage history of whitelisted addresses
Use Cases:
  • Add frequently used exchange addresses
  • Pre-approve personal wallet addresses
  • Manage beneficiary addresses for business accounts
  • Implement security policies requiring address approval

Get all whitelisted addresses for a specific currency.

Authentication

x-client-key
string
required
Your public API client key
Authorization
string
required
Bearer token for authentication

Query Parameters

currency
string
required
Currency of the desired whitelisted addresses (e.g., “xrp”, “usdc”, “eth”)
x-us-env
boolean
default:false
Route to US backend environment

Response

id
string
Unique whitelist entry identifier
name
string
Friendly name or label for the address
beneficiaryFirstName
string
Beneficiary’s first name
beneficiaryLastName
string
Beneficiary’s last name
walletAddress
string
Blockchain address
walletMemo
string
Memo/destination tag (for XRP, Stellar, etc.)
currency
string
Currency code
lastUsedAt
string
ISO 8601 timestamp of last withdrawal to this address
createdAt
string
ISO 8601 timestamp of when address was whitelisted
[
  {
    "id": "d7ed0d12-270c-4491-b1a4-bebf2cc42b5c",
    "name": "Binance Account | Primary",
    "beneficiaryFirstName": "John",
    "beneficiaryLastName": "Doe",
    "walletAddress": "rNxp4h8apvRis6mJf9Sh8C6iRxfrDWN7AA",
    "walletMemo": "66",
    "currency": "xrp",
    "lastUsedAt": "2025-08-12T13:44:47.287Z",
    "createdAt": "2025-08-11T13:44:47.287Z"
  },
  {
    "id": "a3f2e1d4-c5b6-47a8-9e0f-1d2c3b4a5e6f",
    "name": "Kraken Exchange",
    "beneficiaryFirstName": "John",
    "beneficiaryLastName": "Doe",
    "walletAddress": "rPEPPER7kfTD9w2To4CQk6UCfuHM9c6GDY",
    "walletMemo": "12345",
    "currency": "xrp",
    "lastUsedAt": null,
    "createdAt": "2025-08-10T10:30:22.123Z"
  }
]
curl -X GET "https://dev.api.baanx.com/v1/wallet/whitelist?currency=xrp" \
  -H "x-client-key: YOUR_CLIENT_KEY" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Important Notes

Memo Requirements: For networks like XRP and Stellar, the combination of address + memo identifies the destination. Always include both when whitelisting exchange addresses.
Usage Tracking: The lastUsedAt field helps identify frequently vs rarely used addresses. Consider removing unused addresses periodically.
Descriptive Names: Use clear, descriptive names that help identify the purpose and destination of each whitelisted address (e.g., “Binance Main Account | Trading”).