> ## 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.

# List Regions

> Query the list of regions for a given country, used to populate the beneficiary city/region for Travel Rule data.
[  *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/regions
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/regions:
    get:
      tags:
        - Travel Rule
      summary: List Regions
      description: >
        Query the list of regions for a given country, used to populate the
        beneficiary city/region for Travel Rule data.

        [  *Stablecoin Account API Publisher
        Disclaimer*](/stablecoin-account/v1.6/guide/stablecoin-account-api-publisher-disclaimer)
      operationId: list-regions
      parameters:
        - $ref: '#/components/parameters/XOnBehalfOf'
        - name: country
          in: query
          required: true
          schema:
            type: string
            example: us
          description: Country code (ISO 3166-1 alpha-2, lowercase)
      responses:
        '200':
          headers:
            x-response-id:
              $ref: '#/components/headers/XResponseId'
          description: >-
            Successfully retrieved region list (empty array when the country has
            no regions)
          content:
            application/json:
              examples:
                sandbox:
                  summary: Sandbox response
                  value:
                    code: 200
                    message: Success
                    data:
                      - regionName: Alabama
                        blockType: supported
                        depositAllowed: true
                        withdrawalAllowed: true
                      - regionName: Alaska
                        blockType: supported
                        depositAllowed: true
                        withdrawalAllowed: true
                      - regionName: Arizona
                        blockType: supported
                        depositAllowed: true
                        withdrawalAllowed: true
                      - regionName: Arkansas
                        blockType: supported
                        depositAllowed: true
                        withdrawalAllowed: true
                      - regionName: California
                        blockType: supported
                        depositAllowed: true
                        withdrawalAllowed: true
                      - regionName: Colorado
                        blockType: supported
                        depositAllowed: true
                        withdrawalAllowed: true
                      - regionName: Connecticut
                        blockType: supported
                        depositAllowed: true
                        withdrawalAllowed: true
                      - regionName: Delaware
                        blockType: supported
                        depositAllowed: true
                        withdrawalAllowed: true
                      - regionName: District of Columbia
                        blockType: supported
                        depositAllowed: true
                        withdrawalAllowed: true
                      - regionName: Florida
                        blockType: supported
                        depositAllowed: true
                        withdrawalAllowed: true
                      - regionName: Georgia
                        blockType: supported
                        depositAllowed: true
                        withdrawalAllowed: true
                      - regionName: Hawaii
                        blockType: supported
                        depositAllowed: true
                        withdrawalAllowed: true
                      - regionName: Idaho
                        blockType: supported
                        depositAllowed: true
                        withdrawalAllowed: true
                      - regionName: Illinois
                        blockType: supported
                        depositAllowed: true
                        withdrawalAllowed: true
                      - regionName: Indiana
                        blockType: supported
                        depositAllowed: true
                        withdrawalAllowed: true
                      - regionName: Iowa
                        blockType: supported
                        depositAllowed: true
                        withdrawalAllowed: true
                      - regionName: Kansas
                        blockType: supported
                        depositAllowed: true
                        withdrawalAllowed: true
                      - regionName: Kentucky
                        blockType: supported
                        depositAllowed: true
                        withdrawalAllowed: true
                      - regionName: Louisiana
                        blockType: supported
                        depositAllowed: true
                        withdrawalAllowed: true
                      - regionName: Maine
                        blockType: supported
                        depositAllowed: true
                        withdrawalAllowed: true
                      - regionName: Maryland
                        blockType: supported
                        depositAllowed: true
                        withdrawalAllowed: true
                      - regionName: Massachusetts
                        blockType: supported
                        depositAllowed: true
                        withdrawalAllowed: true
                      - regionName: Michigan
                        blockType: supported
                        depositAllowed: true
                        withdrawalAllowed: true
                      - regionName: Minnesota
                        blockType: supported
                        depositAllowed: true
                        withdrawalAllowed: true
                      - regionName: Mississippi
                        blockType: supported
                        depositAllowed: true
                        withdrawalAllowed: true
                      - regionName: Missouri
                        blockType: supported
                        depositAllowed: true
                        withdrawalAllowed: true
                      - regionName: Montana
                        blockType: supported
                        depositAllowed: true
                        withdrawalAllowed: true
                      - regionName: Nebraska
                        blockType: supported
                        depositAllowed: true
                        withdrawalAllowed: true
                      - regionName: Nevada
                        blockType: supported
                        depositAllowed: true
                        withdrawalAllowed: true
                      - regionName: New Hampshire
                        blockType: supported
                        depositAllowed: true
                        withdrawalAllowed: true
                      - regionName: New Jersey
                        blockType: supported
                        depositAllowed: true
                        withdrawalAllowed: true
                      - regionName: New Mexico
                        blockType: supported
                        depositAllowed: true
                        withdrawalAllowed: true
                      - regionName: New York
                        blockType: supported
                        depositAllowed: true
                        withdrawalAllowed: true
                      - regionName: North Carolina
                        blockType: supported
                        depositAllowed: true
                        withdrawalAllowed: true
                      - regionName: North Dakota
                        blockType: supported
                        depositAllowed: true
                        withdrawalAllowed: true
                      - regionName: Ohio
                        blockType: supported
                        depositAllowed: true
                        withdrawalAllowed: true
                      - regionName: Oklahoma
                        blockType: supported
                        depositAllowed: true
                        withdrawalAllowed: true
                      - regionName: Oregon
                        blockType: supported
                        depositAllowed: true
                        withdrawalAllowed: true
                      - regionName: Pennsylvania
                        blockType: supported
                        depositAllowed: true
                        withdrawalAllowed: true
                      - regionName: Rhode Island
                        blockType: supported
                        depositAllowed: true
                        withdrawalAllowed: true
                      - regionName: South Carolina
                        blockType: supported
                        depositAllowed: true
                        withdrawalAllowed: true
                      - regionName: South Dakota
                        blockType: supported
                        depositAllowed: true
                        withdrawalAllowed: true
                      - regionName: Tennessee
                        blockType: supported
                        depositAllowed: true
                        withdrawalAllowed: true
                      - regionName: Texas
                        blockType: supported
                        depositAllowed: true
                        withdrawalAllowed: true
                      - regionName: Utah
                        blockType: supported
                        depositAllowed: true
                        withdrawalAllowed: true
                      - regionName: Vermont
                        blockType: supported
                        depositAllowed: true
                        withdrawalAllowed: true
                      - regionName: Virginia
                        blockType: supported
                        depositAllowed: true
                        withdrawalAllowed: true
                      - regionName: Washington
                        blockType: supported
                        depositAllowed: true
                        withdrawalAllowed: true
                      - regionName: West Virginia
                        blockType: supported
                        depositAllowed: true
                        withdrawalAllowed: true
                      - regionName: Wisconsin
                        blockType: supported
                        depositAllowed: true
                        withdrawalAllowed: true
                      - regionName: Wyoming
                        blockType: supported
                        depositAllowed: true
                        withdrawalAllowed: true
              schema:
                $ref: '#/components/schemas/RegionListResponse'
                title: RegionListResponse
      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:
    RegionListResponse:
      type: object
      required:
        - code
        - message
        - data
      properties:
        code:
          type: integer
          example: 200
        message:
          type: string
          example: Success
        data:
          type: array
          items:
            type: object
            properties:
              regionName:
                type: string
                description: >-
                  Region name. Use this value for
                  `beneficiary_information.city`.
                example: Singapore
  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.