Sign in

v1

latestOpenAPI 3.0.22026-07-26123510445.2 KB
Address Book

Update Address Book

Update an existing wallet address book entry. Use this to edit the label or whitelist flag, or to add/edit Travel Rule data (meta_data) for an address before withdrawing. Stablecoin Account API Publisher Disclaimer

post/v1/ramp/wallet_address/update

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_idstring uuid required

Address entry ID to update

is_whitelistinteger

Whether the address is whitelisted (0: No, 1: Yes)

address_labelstring

Address label/name

Example request

{
  "address_id": "72612f65-6026-4cd0-b184-6c48f4850590",
  "is_whitelist": 1,
  "address_label": "My USDT Wallet",
  "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 updated 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"
      }
    }
  }
}