v1

latestOpenAPI 3.0.22026-07-26123510445.2 KB

Address Book

List Address Book

Query wallet address book list with multi-condition filtering support. Stablecoin Account API Publisher Disclaimer

get/v1/ramp/wallet_address

Query parameters

page_numinteger

Page number, default 1

page_sizeinteger

Items per page, default 10

currencystring

Filter by currency

networkstring

Filter by network

address_type1000 | 2000

Filter by address type (1000=Exchange, 2000=Personal)

address_statusinteger

Filter by address status

verification_status1 | 2

Filter by verification status (1=Verified, 2=Failed)

wallet_addressstring

Filter by wallet address

address_labelstring

Filter by address label

address_kind'whitelist' | 'deposit_sender'

Which kind of entries to return. whitelist (default) returns withdrawal destination addresses; deposit_sender returns the deposit-sender entries recorded via Submit Deposit Sender Travel Rule. Omit it to keep the previous behavior of returning only withdrawal addresses.

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.

Response

Successfully retrieved address book list

codeinteger required

messagestring required

Example response

{
  "code": 200,
  "message": "Success",
  "data": {
    "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"
          }
        }
      }
    ]
  }
}