Address book

Stablecoin Account API Publisher Disclaimer Withdrawals go to addresses registered in your account’s address book. Each entry records the address, its network and currency, whether it is an exchange or personal wallet, and — where compliance requires it — Travel Rule data about the beneficiary. New entries go through automatic risk assessment and validation.

Create an entry

Call Create Address Book with the address details and a legal declaration matching the address type:

curl -X POST https://api-sandbox.uqpaytech.com/api/v1/ramp/wallet_address \
  -H "x-auth-token: YOUR_API_TOKEN" \
  -H "x-idempotency-key: $(uuidgen | tr '[:upper:]' '[:lower:]')" \
  -H "Content-Type: application/json" \
  -d '{
    "address_label": "My USDT Wallet",
    "network": "ETH",
    "currency": "USDT",
    "address_type": 2000,
    "wallet_address": "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb",
    "legal_declaration": "I_CERTIFY_THIS_ADDRESS_IS_MINE",
    "is_whitelist": 1
  }'

Key fields:

Field	Required	Description
`address_label`	Yes	A name to identify the entry
`network`	Yes	Network code, for example `ETH`
`currency`	Yes	Currency code, for example `USDT`
`address_type`	Yes	`1000` for an exchange address, `2000` for a personal wallet
`wallet_address`	Yes	The destination address
`legal_declaration`	Yes	`I_CERTIFY_BENEFICIAL_OWNERSHIP_OF_EXCHANGE_ACCOUNT` when `address_type` is `1000`; `I_CERTIFY_THIS_ADDRESS_IS_MINE` when `address_type` is `2000`
`address_source`	If `address_type=1000`	Where the address came from
`is_whitelist`	No	`1` to whitelist the address for withdrawals, `0` otherwise
`meta_data`	Conditional	Travel Rule data — required for third-party or exchange-hosted addresses, and for Binance-routed withdrawal destinations. See Travel Rule compliance.

The response returns the stored entry using the same representation as List Address Book. In responses, address_type, address_status, and verification_status are integer codes. address_type is 1000 for an exchange address or 2000 for a personal wallet. The entry also includes address_id and need_travel_rule — true when it still has no Travel Rule data.

List entries

Query with List Address Book, filtering by currency, network, address_type, verification_status, wallet_address, or address_label:

curl "https://api-sandbox.uqpaytech.com/api/v1/ramp/wallet_address?page_num=1&page_size=10&currency=USDT" \
  -H "x-auth-token: YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

The address_kind parameter selects which kind of entries you get: whitelist (the default) returns withdrawal destinations; deposit_sender returns the originator records created via Submit Deposit Sender Travel Rule.

Use each entry’s need_travel_rule flag to prompt users to complete beneficiary information before they attempt a withdrawal that requires it.

Update an entry

Update Address Book edits an existing entry — change the label, toggle the whitelist flag, or add and edit Travel Rule meta_data:

curl -X POST https://api-sandbox.uqpaytech.com/api/v1/ramp/wallet_address/update \
  -H "x-auth-token: YOUR_API_TOKEN" \
  -H "x-idempotency-key: $(uuidgen | tr '[:upper:]' '[:lower:]')" \
  -H "Content-Type: application/json" \
  -d '{
    "address_id": "72612f65-6026-4cd0-b184-6c48f4850590",
    "is_whitelist": 1,
    "address_label": "My USDT Wallet"
  }'

Only address_id is required; include just the fields you want to change. Adding meta_data here is how you backfill Travel Rule data on an address that was created without it.

Create Address Book API
Update Address Book API
Travel Rule compliance — when meta_data is required and how to fill it
Send withdrawals

Getting Started

Assets & Balances

Deposits

Withdrawals

Conversions & Transfers

Reference

Create an entry

List entries

Update an entry

​Create an entry

​List entries

​Update an entry

​Related

Create an entry

List entries

Update an entry

Related