List Address Book

get

https://api-sandbox.uqpaytech.com/api/v1/ramp/wallet_address

Query wallet address book list with multi-condition filtering support. U-Ramp API Publisher Disclaimer

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

page_num

integer

≥ 1

Defaults to 1

Page number, default 1

page_size

integer

≥ 1

Defaults to 10

Items per page, default 10

currency

string

Filter by currency

network

string

Filter by network

address_type

integer

enum

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

Allowed:

address_status

integer

Filter by address status

verification_status

integer

enum

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

Allowed:

wallet_address

string

Filter by wallet address

address_label

string

Filter by address label

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.

Responses

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successfully retrieved address book list

400Bad Request - The request was unacceptable, often due to missing a required parameter.

401Unauthorized - No valid API key or token provided.