> ## 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. # 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: d7dd912 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: 在你的 UQPAY 账户下创建和管理子账户。 - 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: allOf: - $ref: '#/components/schemas/EntityType' - type: string enum: - COMPANY 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/RetrieveBusinessDetails' 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: allOf: - $ref: '#/components/schemas/EntityType' - type: string enum: - INDIVIDUAL 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' RetrieveBusinessDetails: type: object description: 公司账户响应中的业务信息。 required: - legal_entity_name_english - incorporation_date - registration_number - business_structure - estimated_worker_count - monthly_estimated_revenue - merchant_category_code - account_purpose properties: legal_entity_name: 81610d8f-b17c-4eb2-b133-7de4484ed82f legal_entity_name_english: cbf61da3-a114-49ac-840f-e28b58d37c14 incorporation_date: ab8e4bcc-bb3e-459b-a86d-70620b493c4c registration_number: fabc7465-53ba-4995-86a7-3b6f2edd3223 business_structure: 3ffeb93a-1a26-4d62-b2e6-20228bb04800 product_description: allOf: - dfda3f02-fbf2-45d8-a020-05c50731fb70 description: 企业提供的产品或服务的描述。没有可用描述时省略此字段。 merchant_category_code: e6c26a84-5a39-406a-9bdd-2c402cc96cc0 estimated_worker_count: 9ad6cb79-7175-4ce1-afac-bba272503b4b monthly_estimated_revenue: d8306f6e-406a-436d-a81c-4fbfba1fdef8 account_purpose: c7eea0af-327f-4cb8-8d88-d6c14e41c2b5 identifier: b4dd0ec5-1b40-4ef8-8e23-f3ea8dc12821 website_url: ee3d6b39-3edd-4403-9be7-930e87e92253 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: 账户的电话号码。 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 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 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。 ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.