> ## Documentation Index > Fetch the complete documentation index at: https://developers.uqpay.com/llms.txt > Use this file to discover all available pages before exploring further. # List Address Book > Query wallet address book list with multi-condition filtering support. [ *Stablecoin Account API Publisher Disclaimer*](/stablecoin-account/v1.6/guide/stablecoin-account-api-publisher-disclaimer) ## OpenAPI ````yaml /stablecoin-account/v1.6/ramp.yaml get /v1/ramp/wallet_address openapi: 3.0.2 info: title: Stablecoin Account API version: 1.0.4 description: > UQPAY Stablecoin Account API provides comprehensive stablecoin account management and payment solutions for fiat-cryptocurrency conversion, enabling complete fund flow loop functionality. ## Key Features - Asset Management: Query and manage wallet balances across multiple currencies - Fiat Transfer: Transfer funds between Stablecoin Account and Global Account systems - Currency Exchange: Crypto-Fiat mutual conversion with real-time quotes - Cryptocurrency Deposit: Receive crypto deposits with address management - Cryptocurrency Withdrawal: Initiate and track crypto withdrawals ## Authentication Use API keys to authenticate your client requests when utilizing UQPAY APIs. API keys are unique data strings used to authenticate users and enable access to privileged operations. Your API key should be kept confidential and secure at all times. ## Getting Started 1. Obtain API credentials (x-client-id and x-api-key) 2. Request access token via POST /api/v1/connect/token 3. Set up test environment using sandbox URL 4. Implement authentication with x-auth-token header 5. Start with basic operations ## Support For technical support and integration assistance, contact UQPAY support team. contact: name: UQPAY Support url: https://www.uqpay.com/support email: ramp.tech@uqpay.com license: name: Proprietary url: https://www.uqpay.com/legal/api-terms termsOfService: https://www.uqpay.com/legal/terms x-api-id: ramp-api-v1.0.0 x-logo: url: https://uqpay.com/img/UQPAY_LogoAnimv2.gif backgroundColor: '#FFFFFF' altText: UQPAY Logo x-categories: - Stablecoin Account - Payment Processing - Cryptocurrency - Fiat Exchange servers: - url: https://api-sandbox.uqpaytech.com/api description: Sandbox base URL. - url: https://api.uqpay.com/api description: Production base URL. security: [] tags: - name: Assets description: >- Manage stablecoin wallet accounts and query balances across different currencies. - name: Transfer (Out/In) description: Transfer funds between Stablecoin Account and Global Account systems. - name: Conversions description: Execute currency conversions between cryptocurrency and fiat currencies. - name: Deposits description: Manage cryptocurrency deposit addresses and track deposit transactions. - name: Withdrawals description: Create and manage cryptocurrency withdrawal requests. - name: Configuration description: Query supported assets, networks, and system configuration. - name: Address Book description: Manage wallet address book entries for withdrawals. - name: Travel Rule description: >- Reference data (VASPs, countries, regions) used to populate Travel Rule beneficiary information for address book entries. paths: /v1/ramp/wallet_address: get: tags: - Address Book summary: List Address Book description: >- Query wallet address book list with multi-condition filtering support. [ *Stablecoin Account API Publisher Disclaimer*](/stablecoin-account/v1.6/guide/stablecoin-account-api-publisher-disclaimer) operationId: list-address-book parameters: - $ref: '#/components/parameters/XOnBehalfOf' - name: page_num in: query required: false schema: type: integer minimum: 1 default: 1 description: Page number, default 1 - name: page_size in: query required: false schema: type: integer minimum: 1 default: 10 description: Items per page, default 10 - name: currency in: query required: false schema: type: string description: Filter by currency - name: network in: query required: false schema: type: string description: Filter by network - name: address_type in: query description: Filter by address type (1000=Exchange, 2000=Personal) required: false schema: type: integer enum: - 1000 - 2000 - name: address_status in: query description: Filter by address status required: false schema: type: integer - name: verification_status in: query description: Filter by verification status (1=Verified, 2=Failed) required: false schema: type: integer enum: - 1 - 2 - name: wallet_address in: query required: false schema: type: string description: Filter by wallet address - name: address_label in: query required: false schema: type: string description: Filter by address label - name: address_kind in: query required: false schema: type: string enum: - whitelist - deposit_sender default: whitelist description: >- 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. responses: '200': headers: x-response-id: $ref: '#/components/headers/XResponseId' description: Successfully retrieved address book list content: application/json: schema: $ref: '#/components/schemas/AddressBookListResponse' title: AddressBookListResponse security: - XAuthToken: [] externalDocs: description: API Publisher Disclaimer – UQPAY Australia url: >- /stablecoin-account/v1.6/guide/stablecoin-account-api-publisher-disclaimer components: parameters: XOnBehalfOf: in: header name: x-on-behalf-of schema: type: string required: false description: > 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. example: 18523f72-f4de-4f9c-bb8e-ec7d1c4f32be headers: XResponseId: description: >- Universally unique identifier (UUID v4) for the response. Helpful for identifying a request when communicating with UQPAY support. schema: type: string format: uuid example: 2adba88e-9d63-44bc-b975-9b6ae3440dde schemas: AddressBookListResponse: type: object required: - code - message - data properties: code: type: integer example: 200 message: type: string example: Success data: type: object required: - data - total_pages - total_items properties: data: type: array items: $ref: '#/components/schemas/AddressBookEntry' total_pages: type: integer total_items: type: integer AddressBookEntry: type: object required: - account_id - address_id - address_type - address_label - network - currency - wallet_address - create_time - address_status - is_owner - receiver_name - verification_status properties: account_id: type: string description: Account ID example: 9276ffba-7b6c-4d1d-b4e9-b4c8fc435160 address_id: type: string format: uuid description: Address entry ID example: 72612f65-6026-4cd0-b184-6c48f4850590 address_type: type: integer description: 'Address type (1000: Exchange, 2000: Personal Wallet)' example: 2000 address_label: type: string description: Address label/name example: My USDT Wallet network: type: string description: Network code example: ETH currency: type: string description: Currency code example: USDT wallet_address: type: string description: Wallet address example: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb' create_time: type: string description: Creation time example: '2026-01-16 14:30:00' address_status: type: integer description: Address status example: 1 is_owner: type: integer description: 'Whether user owns this address (0: No, 1: Yes)' example: 0 receiver_name: type: string description: Receiver name example: John Doe verification_status: type: integer description: 'Verification status (1: Verified, 2: Failed)' example: 1 need_travel_rule: type: boolean description: >- Whether this address still needs Travel Rule data. `true` when `meta_data` is empty; use it to prompt the user to complete the information before withdrawing. example: true meta_data: nullable: true description: >- Stored Travel Rule data for this address; `null` when not yet provided. allOf: - $ref: '#/components/schemas/TravelRuleMetaData' message: type: string description: Error message (returned on failure) TravelRuleMetaData: type: object description: >- Travel Rule data for a counterparty — either a withdrawal destination (address book entry) or a deposit originator (via Submit Deposit Sender Travel Rule). It is required for third-party counterparties (`address_party=third_party`) and hosted wallets (`wallet_type=hosted`). required: - wallet_type - address_party properties: wallet_type: type: string description: >- Custody type of the destination wallet — `hosted` for a custodial/exchange wallet (requires VASP details), `unhosted` for a self-custody/private wallet. enum: - hosted - unhosted example: hosted address_party: type: string description: >- Ownership of the address — `first_party` when it belongs to the account holder, `third_party` when it belongs to another beneficiary. enum: - first_party - third_party example: third_party beneficiary_information: description: >- Beneficiary details. Required when `address_party=third_party` or `wallet_type=hosted`. allOf: - $ref: '#/components/schemas/BeneficiaryInformation' BeneficiaryInformation: type: object description: >- Beneficiary information for the destination address. Individual beneficiaries provide name fields; corporate beneficiaries provide the company name. Hosted wallets additionally require VASP details. properties: entity_type: type: string description: Beneficiary entity type. Required when `address_party=third_party`. enum: - individual - corporation example: individual first_name: type: string description: >- Beneficiary given name. Required for an individual third-party beneficiary. example: John last_name: type: string description: >- Beneficiary family name. Required for an individual third-party beneficiary. example: Doe company_name: type: string description: >- Beneficiary company name. Required for a corporate third-party beneficiary. example: Acme Pte Ltd country: type: string description: >- Beneficiary country code (ISO 3166-1 alpha-2, lowercase). Required for a third party. Use a `countryCode` returned by the Country List endpoint. example: sg city: type: string description: >- Beneficiary city/region. Required for a third party. Use a `regionName` returned by the Region List endpoint. example: Singapore vasp_id: type: string description: >- Beneficiary VASP identifier. Required for a hosted wallet (provide at least one of `vasp_id` / `vasp_name`). Use an `identifier` returned by the VASP List endpoint. example: I1QNLP vasp_name: type: string description: >- VASP name. For a hosted wallet, supply the exchange name here when the VASP is not found in the VASP List (in which case `vasp_id` may be omitted). example: Binance id_type: type: string description: Beneficiary identity document type. Optional. id_primary: type: string description: Beneficiary identity document number. Optional. securitySchemes: XAuthToken: type: apiKey in: header name: x-auth-token description: The API token for login provided by UQPay. ````