Skip to main content
GET
List Address Book

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.

Query Parameters

page_num
integer
default:1

Page number, default 1

Required range: x >= 1
page_size
integer
default:10

Items per page, default 10

Required range: x >= 1
currency
string

Filter by currency

network
string

Filter by network

address_type
enum<integer>

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

Available options:
1000,
2000
address_status
integer

Filter by address status

verification_status
enum<integer>

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

Available options:
1,
2
wallet_address
string

Filter by wallet address

address_label
string

Filter by address label

address_kind
enum<string>
default:whitelist

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.

Available options:
whitelist,
deposit_sender

Response

200 - application/json

Successfully retrieved address book list

code
integer
required
Example:

200

message
string
required
Example:

"Success"

data
object
required