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

# Retrieve Account

> 获取账户的详细信息。



## OpenAPI

````yaml /zh/account-center/v1.6/connect.yaml get /v1/accounts/{id}
openapi: 3.0.2
info:
  version: 0.0.1
  x-source-en-commit: 77b7b49
  x-source-en-path: account-center/v1.6/connect.yaml
  title: Connect
  description: 这些 API 用于管理关联账户。
servers:
  - url: https://api-sandbox.uqpaytech.com/api
    description: Sandbox 基础 URL。
  - url: https://api.uqpay.com/api
    description: 生产环境基础 URL。
security: []
tags:
  - name: Account Center
    description: 在受支持的业务线（Acquiring、Banking、Issuing）下创建和管理子账户。
  - name: Accounts
    description: 借助 Connect，你可以为你的用户创建 UQPAY 账户。为此，你需要先注册你的平台。
  - name: Request for Information (RFI)
    description: 获取并回复在入驻或持续审查期间针对你的账户发起的信息索取请求（RFI）。
paths:
  /v1/accounts/{id}:
    get:
      tags:
        - Accounts
      summary: Retrieve Account
      description: 获取账户的详细信息。
      operationId: retrieve-account
      parameters:
        - $ref: '#/components/parameters/IdPath'
        - name: business_code
          in: query
          required: false
          schema:
            type: string
            enum:
              - BANKING
              - ACQUIRING
              - ISSUING
          description: |
            业务类型代码。默认为 BANKING。
      responses:
        '200':
          description: OK——成功获取账户详细信息。
          headers:
            x-response-id:
              $ref: '#/components/headers/XResponseId'
          content:
            application/json:
              schema:
                title: RetrieveAccountResponse
                oneOf:
                  - $ref: '#/components/schemas/RetrieveAccountResponse'
                    title: Company Account
                  - $ref: '#/components/schemas/RetrieveIndividualAccountResponse'
                    title: Individual Account
      security:
        - XAuthToken: []
components:
  parameters:
    IdPath:
      name: id
      description: 资源的全局唯一标识符（UUID v4）。
      in: path
      required: true
      schema:
        type: string
        format: uuid
        example: b3d9d2d5-4c12-4946-a09d-953e82sed2b0
  headers:
    XResponseId:
      description: 响应的全局唯一标识符（UUID v4）。在与 UQPAY 支持团队沟通时，有助于定位某个请求。
      schema:
        type: string
        format: uuid
        example: 2adba88e-9d63-44bc-b975-9b6ae3440dde
  schemas:
    RetrieveAccountResponse:
      title: Company Account Response
      type: object
      description: 有关该公司或企业的信息。
      properties:
        account_id:
          $ref: '#/components/schemas/AccountId'
        short_reference_id:
          type: string
          example: P220406-LLCVLRM
          description: 账户的短引用 ID。
        business_code:
          $ref: '#/components/schemas/ACCOUNTCENTER_BusinessType'
        email:
          type: string
          example: example@company.com
          description: 账户的电子邮箱地址。
          maxLength: 100
          format: email
        account_name:
          $ref: '#/components/schemas/AccountName'
        country:
          $ref: '#/components/schemas/Country'
        status:
          $ref: '#/components/schemas/AccountStatus'
        verification_status:
          $ref: '#/components/schemas/VerificationStatus'
        entity_type:
          $ref: '#/components/schemas/EntityType'
        review_reason:
          type: string
          description: 账户审核未通过时提供的原因。
          example: The account is not compliant with the company's policies.
        contact_details:
          $ref: '#/components/schemas/ContactDetails'
        business_details:
          $ref: '#/components/schemas/BusinessDetails'
        registration_address:
          $ref: '#/components/schemas/RegistrationAddress'
        business_address:
          type: array
          description: 公司的经营地址。
          items:
            $ref: '#/components/schemas/Address'
            type: object
        representatives:
          type: array
          description: 有关该公司代表人的信息。
          items:
            type: object
            required:
              - representative_id
              - roles
              - first_name
              - last_name
              - nationality
              - date_of_birth
              - identification
              - residential_address
              - as_applicant
            properties:
              representative_id:
                type: string
                example: 72970a7c-7921-431c-b95f-3438724ba16f
                description: 代表人的唯一标识符。
              roles:
                type: string
                example: DIRECTOR
                description: >-
                  企业相关人员的角色。可为
                  `DIRECTOR`、`BENEFICIAL_OWNER`、`DIRECTOR_BENEFICIAL_OWNER`
                  中的任意一个。
                enum:
                  - DIRECTOR
                  - BENEFICIAL_OWNER
                  - DIRECTOR_BENEFICIAL_OWNER
              first_name:
                type: string
                example: Mock
                maxLength: 100
                description: 代表人的名字。
              last_name:
                type: string
                example: Toy
                maxLength: 100
                description: 代表人的姓氏。
              nationality:
                type: string
                example: SG
                maxLength: 2
                description: 代表人的国籍。（两位字母 ISO 3166-2 国家/地区代码）
              date_of_birth:
                type: string
                example: '2024-01-28'
                description: 账户用户的出生日期，格式为 YYYY-MM-DD。
              share_percentage:
                type: string
                example: '20.01'
                description: 账户用户的持股比例，当 roles != "DIRECTOR" 时必填。
              identification:
                type: object
                description: 代表人的身份证件信息。
                required:
                  - type
                  - id_number
                  - documents
                properties:
                  type:
                    type: string
                    example: PASSPORT
                    description: 证件类型。枚举值 `PASSPORT`、`NATIONAL_ID`、`DRIVERS_LICENSE`。
                    enum:
                      - PASSPORT
                      - NATIONAL_ID
                      - DRIVERS_LICENSE
                  id_number:
                    type: string
                    example: 27738277K
                    description: 代表人所在国家/地区适用的官方证件号码。（美国为社会安全号码）
                  documents:
                    $ref: '#/components/schemas/DocumentsOnlyFrontAndBack'
              residential_address:
                $ref: '#/components/schemas/Address'
                description: 代表人的居住地址。
              as_applicant:
                type: boolean
                description: 当前代表人是该公司的授权申请人。
                default: false
              other_doucments:
                type: array
                description: 其他文件，支持 base64 编码内容或文件 ID。
                items:
                  type: object
                  required:
                    - type
                    - front
                  properties:
                    type:
                      type: string
                      enum:
                        - PROOF_OF_ADDRESS
                        - OTHERS
                      description: 文件类型。
                      example: PROOF_OF_ADDRESS
                    front:
                      $ref: '#/components/schemas/ACCOUNTCENTER_FileReference'
        documents:
          type: array
          description: 用于确认公司身份的文件。
          items:
            $ref: '#/components/schemas/DocumentsOnlyFrontAndBackWithType'
        tos_acceptance:
          type: object
          description: 有关该账户接受 UQPAY 服务协议的详细信息。此属性仅可针对 Custom 账户更新。
          required:
            - ip
            - date
            - user_agent
          properties:
            ip:
              type: string
              example: 127.0.0.1
              description: 账户代表人接受其服务协议时所使用的 IP 地址。
            date:
              type: string
              example: '2024-03-22T16:08:02+08:00'
              description: 账户代表人接受其服务协议的日期。
            user_agent:
              type: string
              example: >-
                Mozilla/5.0 (Macintosh; Intel Mac OS X x.y; rv:42.0)
                Gecko/20100101 Firefox/42.0
              description: 账户代表人接受其服务协议时所使用浏览器的 user agent。
    RetrieveIndividualAccountResponse:
      title: Individual Account Response
      type: object
      description: 有关该个人账户的信息。
      properties:
        account_id:
          $ref: '#/components/schemas/AccountId'
        short_reference_id:
          $ref: '#/components/schemas/ShortReferenceId'
        business_code:
          $ref: '#/components/schemas/ACCOUNTCENTER_BusinessType'
        account_name:
          $ref: '#/components/schemas/AccountName'
        status:
          $ref: '#/components/schemas/AccountStatus'
        entity_type:
          $ref: '#/components/schemas/EntityType'
        verification_status:
          $ref: '#/components/schemas/VerificationStatus'
        review_reason:
          $ref: '#/components/schemas/ReviewReason'
        contact_details:
          $ref: '#/components/schemas/ContactDetails'
        person_details:
          $ref: '#/components/schemas/PersonDetails'
        residential_address:
          $ref: '#/components/schemas/Address'
        documents:
          type: array
          description: 为该个人账户提交的身份验证文件。
          items:
            $ref: '#/components/schemas/IndividualDocuments'
        tos_acceptance:
          $ref: '#/components/schemas/TosAcceptance'
    AccountId:
      type: string
      example: f5bb6498-552e-40a5-b14b-616aa04ac1c1
      description: 账户的唯一标识符。
    ACCOUNTCENTER_BusinessType:
      type: array
      example:
        - BANKING
      description: |
        该账户的业务类型。
      items:
        type: string
        enum:
          - BANKING
          - ACQUIRING
          - ISSUING
          - RAMP
    AccountName:
      type: string
      example: UQPAY PTE LTD.
      description: 该账户的客户名称。
    Country:
      type: string
      description: >-
        两位字母国家/地区代码 [ISO 3166-1
        alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)。
      maxLength: 2
      example: US
    AccountStatus:
      type: string
      example: PROCESSING
      description: |
        账户的状态。为以下之一：

          * ACTIVE - 账户已激活。
          * PROCESSING - 账户当前正在审核和处理中。
          * INACTIVE - 账户暂时未激活
          * CLOSED - 账户已关闭。
    VerificationStatus:
      type: string
      example: APPROVED
      enum:
        - APPROVED
        - PENDING
        - REJECT
        - EXPIRED
        - RETURN
      description: |
        KYC/KYB 的状态。为以下之一：

          * REJECT - 账户在身份验证过程中被拒绝。
          * APPROVED - 账户已通过验证且处于激活状态。
          * PENDING - 账户当前正在进行身份验证。
          * EXPIRED - 验证已过期。
          * RETURN - 账户已被退回以进行身份验证，需要重新上传。

          **Webhook 说明：** 在 `accountStatus` webhook 通知中，这两个状态
          分别以 `REJECTED` 和 `RETURNED` 下发（而非 `REJECT` / `RETURN`）。
          其他所有值均相同。参见
          [账户状态 webhook](/zh/account-center/v1.6/webhooks/account-status)。
    EntityType:
      type: string
      description: |
        账户类型。
        此字段为必填，且必须是以下之一：
          * `COMPANY` - 为从事商业活动而设立的实体。
          * `INDIVIDUAL` - 来自业务场景的单一个人。**目前仅适用于 Banking。**
      enum:
        - COMPANY
        - INDIVIDUAL
    ContactDetails:
      type: object
      required:
        - email
        - phone
      properties:
        email:
          type: string
          maxLength: 100
          example: example@company.com
          description: 账户的电子邮箱地址。此项仅用于方便你识别该账户。
          format: email
        phone:
          $ref: '#/components/schemas/Phone'
    BusinessDetails:
      type: object
      description: 该账户的企业信息。
      required:
        - legal_entity_name_english
        - incorporation_date
        - registration_number
        - business_structure
        - product_description
        - estimated_worker_count
        - monthly_estimated_revenue
        - merchant_category_code
        - account_purpose
      properties:
        legal_entity_name:
          type: string
          maxLength: 100
          example: ソフトバンクインターナショナル株式会社
          description: 该公司在相关政府机关登记的正式法定名称。
        legal_entity_name_english:
          type: string
          maxLength: 255
          example: UQPAY PTE LTD.
          description: 该企业在相关政府机关登记的正式法定名称。（仅限 ASCII 字符，例如中文字符的拼音转写）
        incorporation_date:
          type: string
          example: '2013-04-15'
          description: 公司依法成立的日期。
        registration_number:
          type: string
          maxLength: 100
          example: 201901754K
          description: >-
            公司在注册或成立时获得的识别号码（如与报税所用的识别号码不同）。（例如印度公司的 CIN、印度合伙企业的 LLP
            IN，以及香港的公司注册编号）
        business_structure:
          type: string
          example: SOLE_PROPRIETOR
          description: |
            用于标识该公司或法律实体法律结构的类别。 此字段为必填，且必须是以下之一：
            `SOLE_PROPRIETOR`、`LIMITED_COMPANY`、`PARTNERSHIP`、`LISTED`、`OTHERS`。
        product_description:
          type: string
          example: Design and produce high-tech wireless headphones.
          description: 仅供内部使用的、对该企业所销售产品或所提供服务的描述。UQPAY 将其用于风险和核保用途。
        merchant_category_code:
          type: string
          example: '5733'
          description: >
            该账户的商户类别代码（MCC）。MCC 用于根据商户提供的商品或服务对其分类，必须是以下之一（类别名称为国际标准 MCC
            分类，保留英文）：
              * `742` - VETERINARY SERVICES.
              * `1520` - GENERAL CONTRACTORS - RESIDENTIAL BUILDINGS.
              * `1711` - A/C, HEATING OR PLUMBING CONTRACTORS - SALES & INSTALLATION.
              * `1731` - ELECTRICAL CONTRACTORS.
              * `1799` - SPECIAL TRADE CONTRACTORS.
              * `2741` - MISCELLANEOUS PUBLISHING AND PRINTING.
              * `4121` - TAXICABS OR LIMOUSINES.
              * `4214` - MOTOR FREIGHT CARRIERS, TRUCK-LOCAL/LONG.
              * `4215` - COURIER SERVICES-AIR OR GROUND, FREIGHT.
              * `4411` - CRUISE OR STEAMSHIP LINES.
              * `4511` - AIRLINES, AIR CARRIERS (NOT LISTED BELOW).
              * `4722` - TRAVEL AGENCIES.
              * `4789` - TRANSPORTATION SERVICES (NEC).
              * `4829` - MONEY ORDERS -- WIRE TRANSFER.
              * `4900` - ELECTRIC, GAS, SANITARY, TELEPHONE OR WATER UTILITIES.
              * `5013` - MOTOR VEHICLE SUPPLIES AND NEW PARTS.
              * `5021` - COMMERCIAL FURNITURE.
              * `5045` - COMPUTERS AND COMPUTER PERIPHERAL EQUIPMENT AND SOFTWARE.
              * `5046` - COMMERCIAL EQUIPMENT (NEC).
              * `5047` - MEDICAL, DENTAL, OPHTHALMIC AND HOSPITAL EQUIP.
              * `5085` - INDUSTRIAL SUPPLIES (NEC).
              * `5094` - PRECIOUS STONES AND METALS, WATCHES AND JEWELRY.
              * `5111` - STATIONERY, OFFICE SUPPLIES, PRINTING AND WRITING PAPER.
              * `5122` - DRUGS, DRUG PROPRIETARIES AND DRUGGIST SUNDRIES.
              * `5193` - FLORIST SUPPLIES, NURSERY STOCK AND FLOWERS.
              * `5199` - NON-DURABLE GOODS (NEC).
              * `5211` - LUMBER AND BUILDING MATERIALS STORES.
              * `5261` - GARDEN AND LAWN SUPPLY STORES OR NURSERIES.
              * `5262` - MARKETPLACES.
              * `5399` - GENERAL MERCHANDISE OR CONVENIENCE FOOD STORES.
              * `5411` - GROCERY STORES OR SUPERMARKETS.
              * `5511` - AUTO/TRUCK DEALERS NEW/USED SALE REPAIR PARTS & LEASE.
              * `5533` - AUTOMOTIVE PARTS, ACCESSORIES STORES.
              * `5641` - CHILDREN'S AND INFANTS' WEAR STORES.
              * `5691` - MEN'S AND WOMEN'S CLOTHING STORES.
              * `5712` - FURNITURE, HOME FURNISHINGS & EQUIP STORES EXCL APPLIANCES.
              * `5719` - HOME FURNISHING SPECIALTY STORES -- MISCELLANEOUS.
              * `5722` - APPLIANCE STORES (NEC) OR HOUSEHOLD APPLIANCE STORES.
              * `5732` - ELECTRONIC SALES.
              * `5733` - MUSIC STORES, MUSICAL INSTRUMENTS, PIANOS, SHEET MUSIC.
              * `5812` - RESTAURANTS OR EATING PLACES.
              * `5815` - DIGITAL GOODS MEDIA: BOOKS, MOVIES, MUSIC.
              * `5816` - DIGITAL GOODS: GAMES.
              * `5817` - DIGITAL GOODS - APPLICATIONS (Excludes Games).
              * `5912` - PHARMACIES OR DRUG STORES.
              * `5921` - LIQUOR, WINE, PACKAGE OR BEER STORES.
              * `5941` - SPORTING GOODS STORES.
              * `5943` - STATIONERY STORES, OFFICE & SCHOOL SUPPLY STORES.
              * `5944` - CLOCK, JEWELRY, SILVERWARE OR WATCH STORES.
              * `5945` - HOBBY, TOY OR GAMES STORES.
              * `5947` - CARD, GIFT, NOVELTY OR SOUVENIR SHOPS.
              * `5977` - COSMETIC STORES.
              * `5992` - FLORISTS.
              * `5993` - CIGAR STORES AND STANDS.
              * `5995` - PET SHOPS, PET FOODS AND SUPPLIES STORES.
              * `5999` - MISCELLANEOUS & SPECIALTY STORES.
              * `6012` - FINANCIAL INSTITUTIONS - MERCHANDISE & SERVICES.
              * `6211` - SECURITY BROKERS/DEALERS.
              * `6300` - INSURANCE SALES AND UNDERWRITING.
              * `6513` - REAL ESTATE AGENTS AND MANAGERS-RENTALS.
              * `7011` - LODGING,HOTELS,MOTELS,RESORTS.
              * `7032` - SPORT/RECREATIONAL CAMPS.
              * `7210` - CLEANING, LAUNDRY AND GARMENT SERVICES.
              * `7221` - PHOTOGRAPHIC STUDIOS.
              * `7273` - DATING OR ESCORT SERVICES.
              * `7298` - BEAUTY OR HEALTH SPAS.
              * `7299` - MISC PERSONAL SERVICES NOT ELSEWHERE CLASSIFIED.
              * `7311` - ADVERTISING SERVICES.
              * `7333` - PHOTOGRAPHY, ART AND GRAPHIC -- COMMERCIAL.
              * `7349` - CLEANING AND MAINTENANCE, JANITORIAL SERVICES.
              * `7361` - EMPLOYMENT AGENCIES OR TEMPORARY HELP SERVICES.
              * `7372` - COMPUTER PROGRAMMING, SYSTEMS DESIGN OR DATA PROCESSING SERV.
              * `7375` - INFORMATION RETRIEVAL SERVICES.
              * `7379` - COMPUTER MAINTENANCE, REPAIR AND SERVICES.
              * `7392` - MANAGEMENT, PUBLIC RELATIONS OR CONSULTING SERVICES.
              * `7394` - EQUIP, TOOL, FURNITURE, APPLIANCE LEASE/RENTAL.
              * `7399` - BUSINESS SERVICES (NEC).
              * `7512` - CAR RENTAL AGENCIES -- NOT LISTED BELOW.
              * `7800` - GOVERNMENT-OWNED LOTTERIES.
              * `7801` - GOVERNMENT LICENSED CASINOS (ONLINE GAMBLING).
              * `7832` - MOTION PICTURE THEATERS.
              * `7929` - BANDS, ORCHESTRAS OR ENTERTAINERS.
              * `7941` - COMMERCIAL/PROFESSIONAL SPORTS, PROMOTERS, ATHLETIC FIELDS.
              * `7991` - TOURIST ATTRACTIONS AND EXHIBITS.
              * `7997` - MEMBERSHIP CLUBS INCL SPORTS, REC, ATHLETIC, COUNTRY, GOLF.
              * `7999` - AMUSEMENT/RECREATIONAL SERVICES NOT ELSEWHERE CLASSIFIED.
              * `8011` - DOCTORS OR PHYSICIANS.
              * `8043` - OPTICIANS.
              * `8050` - CONVALESCENT HOMES OR NURSING AND PERSONAL CARE FACILITIES.
              * `8062` - HOSPITALS.
              * `8099` - MEDICAL SERVICES AND HEALTH PRACTITIONERS (NEC).
              * `8111` - ATTORNEYS OR LEGAL SERVICES.
              * `8211` - ELEMENTARY OR SECONDARY SCHOOLS.
              * `8220` - UNIVERSITIES, COLLEGES, SR COLLEGES OR PROFESSIONAL SCHOOLS.
              * `8249` - VOCATIONAL OR TRADE SCHOOLS.
              * `8299` - SCHOOLS AND EDUCATIONAL SERVICES (NEC).
              * `8351` - DAY OR CHILD CARE SERVICES.
              * `8398` - CHARITABLE OR SOCIAL SERVICES ORGANIZATIONS.
              * `8651` - POLITICAL ORGANIZATIONS.
              * `8661` - RELIGIOUS ORGANIZATIONS.
              * `8911` - ARCHITECTURAL, ENGINEERING AND SURVEYING SERVICES.
              * `8931` - ACCOUNTING, BOOKKEEPING OR AUDITING SERVICES.
              * `9399` - GOVERNMENT SERVICES (NEC) OR FIRE DEPARTMENTS.
        estimated_worker_count:
          type: string
          example: BS001
          description: |
            当前为该企业工作的员工、承包商、供应商等人数的估计上限，必须是以下之一：
              * `BS001` - 0-1 名员工。
              * `BS002` - 2-10 名员工。
              * `BS003` - 11-50 名员工。
              * `BS004` - 51-200 名员工。
              * `BS005` - 超过 200 名员工。
          enum:
            - BS001
            - BS002
            - BS003
            - BS004
            - BS005
        monthly_estimated_revenue:
          $ref: '#/components/schemas/MonthlyEstimatedRevenue'
        account_purpose:
          type: array
          example:
            - PAYOUT
          description: |
            账户的预期用途，决定可用的业务服务类型：
              * `COLLECTION` - [Banking as service] 直接接收来自全球客户的银行转账
              * `PAYOUT` - [Banking as service] 发起国际转账，跟踪和管理业务支出
              * `CONVERT_FUNDS` - [Banking as service] 换汇并发起国际转账

            注意：
              - 在当前版本中，如果未提供任何值，将默认创建一个 banking 子账户。
              - 在当前版本中，如果提供了多个值，仅会使用第一个值。
          items:
            type: string
            enum:
              - COLLECTION
              - PAYOUT
              - CONVERT_FUNDS
              - CARD_ISSUING
              - PAYMENT
              - USE_API
        identifier:
          $ref: '#/components/schemas/EntityIdentifier'
        website_url:
          type: string
          maxLength: 250
          example: https://yourcompany.com
          description: 该企业公开的网站。
          format: uri
    RegistrationAddress:
      description: 公司的注册地址。
      type: object
      required:
        - city
        - line1
        - postal_code
      properties:
        city:
          type: string
          description: 城市、区、郊区、镇或村。
          maxLength: 100
          example: San Francisco
        line1:
          type: string
          description: 地址行 1（例如街道、邮政信箱或公司名称）。
          maxLength: 100
          example: 9 N Buona Vista Dr
        state:
          type: string
          description: >-
            州或省的两位字母 ISO 3166 代码。仅适用于部分国家/地区，当 country code = "US"、"CA" 或 "MX"
            时必填。
          maxLength: 2
          example: CA
        line2:
          type: string
          description: 地址行 2（例如公寓、套间、单元或楼宇）。
          maxLength: 100
          example: THE METROPOLIS
        postal_code:
          type: string
          description: 邮政编码。
          maxLength: 16
          example: '94103'
    Address:
      type: object
      required:
        - city
        - country
        - line1
        - state
        - postal_code
      properties:
        city:
          type: string
          description: 城市、区、郊区、镇或村。
          maxLength: 100
          example: Singapore
        country:
          type: string
          description: >-
            两位字母国家/地区代码 [ISO 3166-1
            alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)。
          maxLength: 2
          example: SG
        line1:
          type: string
          description: 地址行 1（例如街道、邮政信箱或公司名称）。
          maxLength: 100
          example: 9 N Buona Vista Dr
        state:
          type: string
          description: 州或省的两位字母 ISO 3166 代码。
          maxLength: 2
          example: SG
        line2:
          type: string
          description: 地址行 2（例如公寓、套间、单元或楼宇）。
          maxLength: 100
          example: THE METROPOLIS
        postal_code:
          type: string
          description: 邮政编码。
          maxLength: 16
          example: '138666'
    DocumentsOnlyFrontAndBack:
      type: object
      description: 用于验证身份的法律文件。
      properties:
        front:
          type: string
          example: >-
            https://files.uqpaytech.com/api/v1/files/f715f7e6-eef8-49de-b333-d95847d9e130/20241105/WX20231213-141835@2x.png
          description: 证件正面的 URL。
        back:
          type: string
          example: >-
            https://files.uqpaytech.com/api/v1/files/f715f7e6-eef8-49de-b333-d95847d9e130/20241105/WX20231213-141835@2x.png
          description: 证件背面的 URL。
    ACCOUNTCENTER_FileReference:
      type: string
      description: |
        文件引用。支持 base64 编码内容或由 UQPAY 签发的文件 ID。
      example: b3d9d2d5-4c12-4946-a09d-953e82sed2b0
    DocumentsOnlyFrontAndBackWithType:
      type: object
      description: 用于验证身份的法律文件。
      properties:
        type:
          type: string
          example: CERTIFICATE_OF_INCORPORATION
          description: >-
            文件类型。枚举值
            `CERTIFICATE_OF_INCORPORATION`、`ARTICLES_OF_ASSOCIATION`、`SHAREHOLDING_STRUCTURE_CERTIFICATE`、`OTHERS`。
        front:
          type: string
          example: >-
            https://files.uqpaytech.com/api/v1/files/f715f7e6-eef8-49de-b333-d95847d9e130/20241105/WX20231213-141835@2x.png
          description: 证件正面的 URL。
        back:
          type: string
          example: >-
            https://files.uqpaytech.com/api/v1/files/f715f7e6-eef8-49de-b333-d95847d9e130/20241105/WX20231213-141835@2x.png
          description: 证件背面的 URL。
    ShortReferenceId:
      type: string
      example: P220406-LLCVLRM
      description: 账户的短引用 ID。
    ReviewReason:
      type: string
      example: The account is not compliant with the company's policies.
    PersonDetails:
      type: object
      properties:
        first_name_english:
          $ref: '#/components/schemas/FirstNameEnglish'
        last_name_english:
          $ref: '#/components/schemas/LastNameEnglish'
        first_name:
          $ref: '#/components/schemas/FirstName'
        last_name:
          $ref: '#/components/schemas/LastName'
        local_name:
          $ref: '#/components/schemas/LocalName'
        nationality:
          $ref: '#/components/schemas/Nationality'
        date_of_birth:
          $ref: '#/components/schemas/DateOfBirth'
        tax_number:
          $ref: '#/components/schemas/TaxNumber'
        internationally:
          $ref: '#/components/schemas/Internationally'
        banking_currencies:
          $ref: '#/components/schemas/BankingCurrencies'
        banking_countries:
          $ref: '#/components/schemas/BankingCountries'
        monthly_estimated_revenue:
          $ref: '#/components/schemas/MonthlyEstimatedRevenue'
        other_purpose:
          $ref: '#/components/schemas/OtherPurpose'
        account_purpose:
          $ref: '#/components/schemas/IndividualAccountPurpose'
        identification:
          $ref: '#/components/schemas/IndividualIdentification'
    IndividualDocuments:
      type: object
      description: |
        用于验证身份的法律文件。
        对于每一面（正面/背面），`*_file_id`、`*` 中只需提供其一。
      required:
        - type
      properties:
        type:
          type: string
          example: PROOF_OF_ADDRESS
          description: |
            文件类型。

            - `PROOF_OF_ADDRESS`：可选。例如银行对账单、公用事业账单或其他显示姓名和地址的官方文件。
            - `SOURCE_OF_FUNDS`：可选。例如纳税证明、房产证明、存款证明、财富证明、银行对账单、银行账户流水等。
            - `PROOF_OF_POSITION_AND_INCOME`：可选。例如雇主公司出具的职位和收入证明文件。
            - `OTHERS`：可选。任何其他可支持你申请的证明文件。
          enum:
            - PROOF_OF_ADDRESS
            - SOURCE_OF_FUNDS
            - PROOF_OF_POSITION_AND_INCOME
            - OTHERS
        front:
          type: string
          format: base64-encoded
          example: >-
            data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=
          description: 证件正面，必须以类似 "data:image/jpeg;base64," 的前缀开头，后接实际的 base64 编码内容。
        front_file_id:
          type: string
          format: uuid
          example: 5135e6cc-28b6-4889-81dc-3b86a09e1395
          description: 正面文件的文件 ID，文件 ID 由文件上传 API 生成。
        back:
          type: string
          format: base64-encoded
          example: >-
            data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=
          description: 证件背面，必须以类似 "data:image/jpeg;base64," 的前缀开头，后接实际的 base64 编码内容。
        back_file_id:
          type: string
          format: uuid
          example: 5135e6cc-28b6-4889-81dc-3b86a09e1395
          description: 背面文件的文件 ID，文件 ID 由文件上传 API 生成。
    TosAcceptance:
      type: object
      description: |
        有关该账户接受 UQPAY 服务协议的详细信息。 此属性仅可针对 Custom 账户更新。
      required:
        - ip
        - date
        - user_agent
      properties:
        ip:
          type: string
          example: 0.0.0.0
          description: |
            账户代表人接受其服务协议时所使用的 IP 地址。
          format: ipv4
        date:
          type: string
          format: date-time
          example: '2024-03-22T16:08:02+08:00'
          description: |
            账户代表人接受其服务协议的日期。
        user_agent:
          type: string
          example: >-
            Mozilla/5.0 (Macintosh; Intel Mac OS X x.y; rv:42.0) Gecko/20100101
            Firefox/42.0
          description: |
            账户代表人接受其服务协议时所使用浏览器的 user agent。
    Phone:
      type: string
      example: '+6588880000'
      description: 账户的电话号码。
    MonthlyEstimatedRevenue:
      type: object
      required:
        - amount
        - currency
      properties:
        amount:
          type: string
          example: TM001
          description: |
            当月的业务总收入，必须是以下之一：
              * `TM001` - 低于 50,000。
              * `TM002` - 50,000 至 100,000。
              * `TM003` - 100,000 至 250,000。
              * `TM004` - 250,000 至 500,000。
              * `TM005` - 超过 500,000。
          enum:
            - TM001
            - TM002
            - TM003
            - TM004
            - TM005
        currency:
          type: string
          description: >-
            币种代码
            [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes)。
          maxLength: 3
          example: SGD
    EntityIdentifier:
      type: object
      properties:
        type:
          type: string
          default: VAT
          description: |
            此字段为必填，且必须是以下之一：
              * `VAT` - 公司的增值税号。
              * `TAX` - 公司的营业识别号码，依公司所在国家/地区而定。（例如美国的雇主识别号、加拿大的企业号或英国的公司编号。）
              * `GST` - 商品及服务税（GST）是许多国家/地区对大多数用于境内消费的商品和服务征收的一种税。
          enum:
            - VAT
            - TAX
            - GST
        number:
          type: string
          description: 识别号码（例如增值税登记号、税号或 GST 号码）。
          maxLength: 255
          example: XXX-XX-XXXX
    FirstNameEnglish:
      type: string
      example: John
      description: 该个人的英文名字。应与护照等官方英文证件上显示的姓名一致。
    LastNameEnglish:
      type: string
      example: Doe
      description: 该个人的英文姓氏。应与护照等官方英文证件上显示的姓名一致。
    FirstName:
      type: string
      example: 三
      description: 该个人母语形式的名字。
    LastName:
      type: string
      example: 张
      description: 该个人母语形式的姓氏。
    LocalName:
      type: string
      example: 张三
      description: 母语形式的姓名。
    Nationality:
      type: string
      maxLength: 2
      description: 两位字母 ISO 3166-2 国家/地区代码
      example: US
    DateOfBirth:
      type: string
      format: date
      example: '1990-01-01'
      description: 该个人的出生日期，格式为 YYYY-MM-DD。
    TaxNumber:
      type: string
      example: 123-45-6789
    Internationally:
      type: integer
      enum:
        - 0
        - 1
      description: |
        表示该账户是否会涉及国际交易，包括跨境收款或付款。
        - `0`：否
        - `1`：是
    BankingCurrencies:
      type: array
      description: 你预计收付款最多的 3 种币种。
      items:
        type: string
        example: USD
    BankingCountries:
      type: array
      description: 你预计收付款最多的 3 个国家/地区。
      items:
        type: string
        example: US
    OtherPurpose:
      type: string
      description: 当 `account_purpose = OTHERS` 时必填。用于提供有关账户用途的更多信息的补充文本。
    IndividualAccountPurpose:
      type: array
      description: |
        账户的使用用途。选择一个或多个适用的持有和使用账户的理由。如果选择了 `others`，请提供额外说明。

        - `purchase`：带发票的个人需求付款。
        - `bill_payment`：缴纳公用事业费。
        - `educational_expenses`：用于支付海外学费、住宿费或其他教育费用。
        - `personal_remittance`：汇给海外亲友用于个人开支的资金。
        - `loan_repayment`：为偿还另一国家/地区的贷款或债务而进行的转账。
        - `investment`：与投资活动相关的转账，例如为境外投资或投资国际金融产品提供资金。
        - `charitable_donation`：为境外慈善事业或非营利组织汇出的款项。
        - `others`：请详细说明用途。
      items:
        type: string
        enum:
          - purchase
          - bill_payment
          - educational_expenses
          - personal_remittance
          - loan_repayment
          - investment
          - charitable_donation
          - others
    IndividualIdentification:
      type: object
      required:
        - type
        - id_number
        - documents
      properties:
        type:
          $ref: '#/components/schemas/IdentificationType'
        id_number:
          $ref: '#/components/schemas/IdentificationIdNumber'
        remark:
          $ref: '#/components/schemas/IdentificationRemark'
        citizenship_status:
          type: string
          description: |
            该个人的新加坡公民身份状态。仅适用于与新加坡相关的账户。
            - `non_resident`：非新加坡居民。
            - `singapore_citizen`：新加坡公民。
            - `permanent_resident`：新加坡永久居民。
          enum:
            - non_resident
            - singapore_citizen
            - permanent_resident
          example: non_resident
        documents:
          $ref: '#/components/schemas/NoTypeDocuments'
    IdentificationType:
      type: string
      enum:
        - PASSPORT
        - NATIONAL_ID
        - DRIVERS_LICENSE
      example: PASSPORT
      description: 身份证件的类型。
    IdentificationIdNumber:
      type: string
      example: A12345678
      description: 该个人的证件号码。
    IdentificationRemark:
      type: string
      example: Valid until 2030
    NoTypeDocuments:
      type: object
      description: |
        用于验证身份的法律文件。
        对于每一面（正面/背面），`*_file_id`、`*` 中只需提供其一。
      properties:
        front:
          type: string
          format: base64-encoded
          example: >-
            data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=
          description: 证件正面，必须以类似 "data:image/jpeg;base64," 的前缀开头，后接实际的 base64 编码内容。
        front_file_id:
          type: string
          format: uuid
          example: 5135e6cc-28b6-4889-81dc-3b86a09e1395
          description: 正面文件的文件 ID，文件 ID 由文件上传 API 生成。
        back:
          type: string
          format: base64-encoded
          example: >-
            data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=
          description: >-
            除护照外，所有证件类型都需要提供证件背面，且必须以类似 "data:image/jpeg;base64," 的前缀开头，后接实际的
            base64 编码内容。
        back_file_id:
          type: string
          format: uuid
          example: 5135e6cc-28b6-4889-81dc-3b86a09e1395
          description: 背面文件的文件 ID，文件 ID 由文件上传 API 生成。
  securitySchemes:
    XAuthToken:
      type: apiKey
      in: header
      name: x-auth-token
      description: 由 UQPAY 提供的登录 API Token。

````