> ## Documentation Index
> Fetch the complete documentation index at: https://developers-sandbox.uqpaytech.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Update Address Book

> Update an existing wallet address book entry. Use this to edit the label or whitelist flag, or to add/edit Travel Rule data (`meta_data`) for an address before withdrawing.
[  *Stablecoin Account API Publisher Disclaimer*](/stablecoin-account/v1.6/guide/stablecoin-account-api-publisher-disclaimer)




## OpenAPI

````yaml /stablecoin-account/v1.6/ramp.yaml post /v1/ramp/wallet_address/update
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/update:
    post:
      tags:
        - Address Book
      summary: Update Address Book
      description: >
        Update an existing wallet address book entry. Use this to edit the label
        or whitelist flag, or to add/edit Travel Rule data (`meta_data`) for an
        address before withdrawing.

        [  *Stablecoin Account API Publisher
        Disclaimer*](/stablecoin-account/v1.6/guide/stablecoin-account-api-publisher-disclaimer)
      operationId: update-address-book
      parameters:
        - $ref: '#/components/parameters/XOnBehalfOf'
        - $ref: '#/components/parameters/XIdempotencyKey'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddressBookUpdateRequest'
            examples:
              sandbox:
                summary: Sandbox request
                value:
                  address_id: 8b7e6430-db4b-4826-90e3-af2f81bf6d23
                  address_label: Add Address Book Test
      responses:
        '200':
          headers:
            x-response-id:
              $ref: '#/components/headers/XResponseId'
          description: Address book entry updated successfully
          content:
            application/json:
              examples:
                sandbox:
                  summary: Sandbox response
                  value:
                    code: 200
                    message: Success
                    data:
                      address_id: 8b7e6430-db4b-4826-90e3-af2f81bf6d23
              schema:
                $ref: '#/components/schemas/AddressBookUpdateResponse'
                title: AddressBookUpdateResponse
      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
    XIdempotencyKey:
      in: header
      name: x-idempotency-key
      schema:
        type: string
        format: uuid
      required: false
      description: >-
        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.
      example: 2adef8e0-9d63-44bc-b975-9b6ae3440dde
  schemas:
    AddressBookUpdateRequest:
      type: object
      required:
        - address_id
      properties:
        address_id:
          type: string
          format: uuid
          description: Address entry ID to update
          example: 72612f65-6026-4cd0-b184-6c48f4850590
        is_whitelist:
          type: integer
          description: 'Whether the address is whitelisted (0: No, 1: Yes)'
          example: 1
        address_label:
          type: string
          description: Address label/name
          example: My USDT Wallet
        meta_data:
          description: >-
            Travel Rule data to add or edit for this address. Stored as the
            address's `travel_rule_data`.
          allOf:
            - $ref: '#/components/schemas/TravelRuleMetaData'
    AddressBookUpdateResponse:
      type: object
      required:
        - code
        - message
        - data
      properties:
        code:
          type: integer
        message:
          type: string
        data:
          type: object
          required:
            - address_id
          properties:
            address_id:
              type: string
              description: Identifier of the updated address book entry.
    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.
  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
  securitySchemes:
    XAuthToken:
      type: apiKey
      in: header
      name: x-auth-token
      description: The API token for login provided by UQPAY.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.