Sign in

v1

latestOpenAPI 3.0.22026-07-26123510445.2 KB
Address Book

Create Address Book

Create wallet address book entry, supporting Exchange addresses and Personal Wallet addresses. Automatic address risk assessment and validation is performed. Stablecoin Account API Publisher Disclaimer

post/v1/ramp/wallet_address

Headers

x-on-behalf-ofstring

Specifies the sub-account on whose behalf the request is made. This should be set to the account_id, which can be retrieved via the List Connected Accounts API. If omitted or empty, the request is executed using the master account. More information at Connected Accounts.

x-idempotency-keystring uuid

A unique identifier (UUID) used to maintain operation idempotency, ensuring that repeated executions of the same operation do not result in unintended effects or duplication. It helps preserve data consistency in the face of network errors, retries, or failures.

Request body

address_labelstring required

Address label/name

networkstring required

Network code

currencystring required

Currency code

address_typeinteger required

Address type (1000: Exchange, 2000: Personal Wallet)

wallet_addressstring required

Wallet address

address_sourcestring

Address source (required if address_type=1000)

legal_declaration'I_CERTIFY_BENEFICIAL_OWNERSHIP_OF_EXCHANGE_ACCOUNT' | 'I_CERTIFY_THIS_ADDRESS_IS_MINE' required

address_type=1000: I_CERTIFY_BENEFICIAL_OWNERSHIP_OF_EXCHANGE_ACCOUNT; address_type=2000: I_CERTIFY_THIS_ADDRESS_IS_MINE

is_whitelistinteger

Whether to add this address to the whitelist (0: No, 1: Yes)

Example request

{
  "address_label": "My USDT Wallet",
  "network": "ETH",
  "currency": "USDT",
  "address_type": 2000,
  "wallet_address": "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb",
  "address_source": "manual",
  "meta_data": {
    "wallet_type": "hosted",
    "address_party": "third_party",
    "beneficiary_information": {
      "entity_type": "individual",
      "first_name": "John",
      "last_name": "Doe",
      "company_name": "Acme Pte Ltd",
      "country": "sg",
      "city": "Singapore",
      "vasp_id": "I1QNLP",
      "vasp_name": "Binance"
    }
  }
}

Response

Address book entry created successfully

codeinteger required
messagestring required

Example response

{
  "code": 200,
  "message": "success",
  "data": {
    "account_id": "9276ffba-7b6c-4d1d-b4e9-b4c8fc435160",
    "address_id": "72612f65-6026-4cd0-b184-6c48f4850590",
    "address_type": 2000,
    "address_label": "My USDT Wallet",
    "network": "ETH",
    "currency": "USDT",
    "wallet_address": "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb",
    "create_time": "2026-01-16 14:30:00",
    "address_status": 1,
    "receiver_name": "John Doe",
    "verification_status": 1,
    "need_travel_rule": true,
    "meta_data": {
      "wallet_type": "hosted",
      "address_party": "third_party",
      "beneficiary_information": {
        "entity_type": "individual",
        "first_name": "John",
        "last_name": "Doe",
        "company_name": "Acme Pte Ltd",
        "country": "sg",
        "city": "Singapore",
        "vasp_id": "I1QNLP",
        "vasp_name": "Binance"
      }
    }
  }
}