Skip to main content
POST
/
v1
/
ramp
/
wallet_address
Create Address Book
curl --request POST \
  --url https://api-sandbox.uqpaytech.com/api/v1/ramp/wallet_address \
  --header 'Content-Type: application/json' \
  --header 'x-auth-token: <api-key>' \
  --data '
{
  "address_label": "My USDT Wallet",
  "network": "ETH",
  "currency": "USDT",
  "address_type": 2000,
  "wallet_address": "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb",
  "legal_declaration": "I_CERTIFY_BENEFICIAL_OWNERSHIP_OF_EXCHANGE_ACCOUNT",
  "address_source": "manual"
}
'
{
  "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,
    "is_owner": 0,
    "receiver_name": "John Doe",
    "verification_status": 1,
    "message": "<string>"
  }
}

Authorizations

​
x-auth-token
string
header
required

The API token for login provided by UQPay.

Headers

​
x-on-behalf-of
string

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-key
string<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.

Body

application/json
​
address_label
string
required

Address label/name

Example:

"My USDT Wallet"

​
network
string
required

Network code

Example:

"ETH"

​
currency
string
required

Currency code

Example:

"USDT"

​
address_type
integer
required

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

Example:

2000

​
wallet_address
string
required

Wallet address

Example:

"0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb"

​
legal_declaration
enum<string>
required

address_type=1000: I_CERTIFY_BENEFICIAL_OWNERSHIP_OF_EXCHANGE_ACCOUNT; address_type=2000: I_CERTIFY_THIS_ADDRESS_IS_MINE

Available options:
I_CERTIFY_BENEFICIAL_OWNERSHIP_OF_EXCHANGE_ACCOUNT,
I_CERTIFY_THIS_ADDRESS_IS_MINE
​
address_source
string

Address source (required if address_type=1000)

Example:

"manual"

Response

Address book entry created successfully

​
code
integer
required
Example:

200

​
message
string
required
Example:

"success"

​
data
object
required