> ## 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 > Retrieves the details of an account. ## OpenAPI ````yaml /account-center/v1.6/connect.yaml get /v1/accounts/{id} openapi: 3.0.2 info: version: 0.0.1 title: Connect description: These APIs are designed for management of connected accounts. 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: Account Center description: >- Create and manage sub-accounts under supported business lines (Acquiring, Banking, Issuing). - name: Accounts description: >- With Connect, you can create UQPAY accounts for your users. To do this, you'll first need to register your platform. - name: Request for Information (RFI) description: >- Retrieve and answer Requests for Information (RFI) raised against your account during onboarding or ongoing review. paths: /v1/accounts/{id}: get: tags: - Accounts summary: Retrieve Account description: Retrieves the details of an account. operationId: retrieve-account parameters: - $ref: '#/components/parameters/IdPath' - name: business_code in: query required: false schema: type: string enum: - BANKING - ACQUIRING - ISSUING description: | Business type code. Default to BANKING. responses: '200': description: OK - Successfully retrieved an account details. 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: Universally unique identifier (UUID v4) of a resource. in: path required: true schema: type: string format: uuid example: b3d9d2d5-4c12-4946-a09d-953e82sed2b0 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: RetrieveAccountResponse: title: Company Account Response type: object description: Information about the company or business. properties: account_id: $ref: '#/components/schemas/AccountId' short_reference_id: type: string example: P220406-LLCVLRM description: The short reference ID of the account. business_code: $ref: '#/components/schemas/ACCOUNTCENTER_BusinessType' email: type: string example: example@company.com description: The email address of the account. 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: The reason provided when the account review was not approved. 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: The company's business address. items: $ref: '#/components/schemas/Address' type: object representatives: type: array description: Information about the representatives of the company. 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: The unique identifier for the representative. roles: type: string example: DIRECTOR description: >- Roles of the business person. Any of `DIRECTOR`, `BENEFICIAL_OWNER`, `DIRECTOR_BENEFICIAL_OWNER`. enum: - DIRECTOR - BENEFICIAL_OWNER - DIRECTOR_BENEFICIAL_OWNER first_name: type: string example: Mock maxLength: 100 description: The representative's first name. last_name: type: string example: Toy maxLength: 100 description: The representative's last name. nationality: type: string example: SG maxLength: 2 description: >- Nationality of the representative. (2-letter ISO 3166-2 country code) date_of_birth: type: string example: '2024-01-28' description: Birth date of the account's user in YYYY-MM-DD format. share_percentage: type: string example: '20.01' description: >- Share percentage of the account's user, required where roles != "DIRECTOR". identification: type: object description: Identity document information for the representative. required: - type - id_number - documents properties: type: type: string example: PASSPORT description: >- The type of identification. Enum `PASSPORT`,`NATIONAL_ID`,`DRIVERS_LICENSE`. enum: - PASSPORT - NATIONAL_ID - DRIVERS_LICENSE id_number: type: string example: 27738277K description: >- The official ID number, as applicable in the representative's country. (For US, the Social Security Number) documents: $ref: '#/components/schemas/DocumentsOnlyFrontAndBack' residential_address: $ref: '#/components/schemas/Address' description: The representative's residential address. as_applicant: type: boolean description: >- The current representative is the authorized applicant of the company. default: false other_doucments: type: array description: Other documents, supports base64-encoded content or file id. items: type: object required: - type - front properties: type: type: string enum: - PROOF_OF_ADDRESS - OTHERS description: Type of document. example: PROOF_OF_ADDRESS front: $ref: '#/components/schemas/ACCOUNTCENTER_FileReference' documents: type: array description: The document to use to confirm the company's identity. items: $ref: '#/components/schemas/DocumentsOnlyFrontAndBackWithType' tos_acceptance: type: object description: >- Details on the account's acceptance of the UQPAY Services Agreement This property can only be updated for Custom accounts. required: - ip - date - user_agent properties: ip: type: string example: 127.0.0.1 description: >- The IP address from which the account representative accepted their service agreement. date: type: string example: '2024-03-22T16:08:02+08:00' description: >- The date when the account representative accepted their service agreement. user_agent: type: string example: >- Mozilla/5.0 (Macintosh; Intel Mac OS X x.y; rv:42.0) Gecko/20100101 Firefox/42.0 description: >- The user agent of the browser from which the account representative accepted their service agreement. RetrieveIndividualAccountResponse: title: Individual Account Response type: object description: Information about the individual account. 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: >- Identity verification documents submitted for the individual account. items: $ref: '#/components/schemas/IndividualDocuments' tos_acceptance: $ref: '#/components/schemas/TosAcceptance' AccountId: type: string example: f5bb6498-552e-40a5-b14b-616aa04ac1c1 description: A unique identifier of the account. ACCOUNTCENTER_BusinessType: type: array example: - BANKING description: | The business type for the account. items: type: string enum: - BANKING - ACQUIRING - ISSUING - RAMP AccountName: type: string example: UQPAY PTE LTD. description: The customer name of the account. Country: type: string description: >- Two-letter country code [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: | Status of the account. One of the following: * ACTIVE - The account has been activated. * PROCESSING - The account is currently undergoing review and processing. * INACTIVE - The account temporarily inactive * CLOSED - The account has been closed. VerificationStatus: type: string example: APPROVED enum: - APPROVED - PENDING - REJECT - EXPIRED - RETURN description: | Status of the KYC/KYB. One of the following: * REJECT - The account has been rejected during identity verification. * APPROVED - The account has been verified and is active. * PENDING - The account is currently undergoing identity verification. * EXPIRED - The verification has expired. * RETURN - The account has been returned for identity verification and needs to be re-uploaded. **Webhook note:** In the `accountStatus` webhook notification, these two states are delivered as `REJECTED` and `RETURNED` respectively (rather than `REJECT` / `RETURN`). All other values are identical. See [Account Status webhook](/account-center/v1.6/webhooks/account-status). EntityType: type: string description: | Type of account. This field is mandatory and must be one of: * `COMPANY` - A entity formed to engage in commercial. * `INDIVIDUAL` - A single person from business contexts. **Currently only available for Banking.** enum: - COMPANY - INDIVIDUAL ContactDetails: type: object required: - email - phone properties: email: type: string maxLength: 100 example: example@company.com description: >- The email address of the account. This is only to make the account easier to identify to you. format: email phone: $ref: '#/components/schemas/Phone' BusinessDetails: type: object description: Business information about the account. 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: >- The official legal name of the company as registered with the relevant government authority. legal_entity_name_english: type: string maxLength: 255 example: UQPAY PTE LTD. description: >- The official legal name of the business as registered with the relevant government authority. (in ASCII characters only, e.g. pinyin transliteration of Chinese characters) incorporation_date: type: string example: '2013-04-15' description: The date when a company is legally formed. registration_number: type: string maxLength: 100 example: 201901754K description: >- The identification number given to a company when it is registered or incorporated, if distinct from the identification number used for filing taxes. (Examples are the CIN for companies and LLP IN for partnerships in India, and the Company Registration Number in Hong Kong). business_structure: type: string example: SOLE_PROPRIETOR description: > The category identifying the legal structure of the company or legal entity. This field is mandatory and must be one of: `SOLE_PROPRIETOR`, `LIMITED_COMPANY`, `PARTNERSHIP`, `LISTED`, `OTHERS`. product_description: type: string example: Design and produce high-tech wireless headphones. description: >- Internal-only description of the product sold by, or service provided by, the business. Used by UQPAY for risk and underwriting purposes. merchant_category_code: type: string example: '5733' description: > The merchant category code for the account. MCCs are used to classify businesses based on the goods or services they provide and must be one of: * `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: > An estimated upper bound of employees, contractors, vendors, etc. currently working for the business，and must be one of: * `BS001` - 0-1 Employee. * `BS002` - 2-10 Employees. * `BS003` - 11-50 Employees. * `BS004` - 51-200 Employees. * `BS005` - >200 Employees. enum: - BS001 - BS002 - BS003 - BS004 - BS005 monthly_estimated_revenue: $ref: '#/components/schemas/MonthlyEstimatedRevenue' account_purpose: type: array example: - PAYOUT description: > The intended purpose of the account, which determines the type of business services available: * `COLLECTION` - [Banking as service] Receive bank transfers directly from customers around the world * `PAYOUT` - [Banking as service] Make international transfers, Track and manage business expenses * `CONVERT_FUNDS` - [Banking as service] Convert funds and make international transfers Note: - In the current version, if no value is provided, a banking sub-account will be created by default. - In the current version, if multiple values are provided, only the first value will be used. 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: The business's publicly available website. format: uri RegistrationAddress: description: The company's registration address. type: object required: - city - line1 - postal_code properties: city: type: string description: City, district, suburb, town, or village. maxLength: 100 example: San Francisco line1: type: string description: Address line 1 (e.g., street, PO Box, or company name). maxLength: 100 example: 9 N Buona Vista Dr state: type: string description: >- State or province two-letter ISO 3166 code. Only applicable to some countries, required where country code = "US", "CA" or "MX". maxLength: 2 example: CA line2: type: string description: Address line 2 (e.g., apartment, suite, unit, or building). maxLength: 100 example: THE METROPOLIS postal_code: type: string description: ZIP or postal code. maxLength: 16 example: '94103' Address: type: object required: - city - country - line1 - state - postal_code properties: city: type: string description: City, district, suburb, town, or village. maxLength: 100 example: Singapore country: type: string description: >- Two-letter country code [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). maxLength: 2 example: SG line1: type: string description: Address line 1 (e.g., street, PO Box, or company name). maxLength: 100 example: 9 N Buona Vista Dr state: type: string description: State or province two-letter ISO 3166 code. maxLength: 2 example: SG line2: type: string description: Address line 2 (e.g., apartment, suite, unit, or building). maxLength: 100 example: THE METROPOLIS postal_code: type: string description: ZIP or postal code. maxLength: 16 example: '138666' DocumentsOnlyFrontAndBack: type: object description: A legal document used to verify identity. properties: front: type: string example: >- https://files.uqpaytech.com/api/v1/files/f715f7e6-eef8-49de-b333-d95847d9e130/20241105/WX20231213-141835@2x.png description: The url of the front document. back: type: string example: >- https://files.uqpaytech.com/api/v1/files/f715f7e6-eef8-49de-b333-d95847d9e130/20241105/WX20231213-141835@2x.png description: The url of the back document. ACCOUNTCENTER_FileReference: type: string description: > File reference. Supports base64-encoded content or a file ID issued by UQPAY. example: b3d9d2d5-4c12-4946-a09d-953e82sed2b0 DocumentsOnlyFrontAndBackWithType: type: object description: A legal document used to verify identity. properties: type: type: string example: CERTIFICATE_OF_INCORPORATION description: >- The type of document. Enum `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: The url of the front document. back: type: string example: >- https://files.uqpaytech.com/api/v1/files/f715f7e6-eef8-49de-b333-d95847d9e130/20241105/WX20231213-141835@2x.png description: The url of the back document. ShortReferenceId: type: string example: P220406-LLCVLRM description: The short reference ID of the account. 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: | A legal document used to verify identity. For each side (front/back), only one of `*_file_id`, `*` is required. required: - type properties: type: type: string example: PROOF_OF_ADDRESS description: > The type of document. - `PROOF_OF_ADDRESS`: Optional. Such as bank statements, utility bills, or other official documents, showing name and address. - `SOURCE_OF_FUNDS`: Optional. Such as tax payment certificate, real estate proof, deposit certificate, wealth certificate, bank statements, bank account statements, etc. - `PROOF_OF_POSITION_AND_INCOME`: Optional. Such as the position and income certification document issued by the employing company. - `OTHERS`: Optional. Any other proof documents that may support your application. 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: >- The front of the document and must start with a prefix like "data:image/jpeg;base64," followed by the actual base64-encoded. front_file_id: type: string format: uuid example: 5135e6cc-28b6-4889-81dc-3b86a09e1395 description: >- The file ID of the front document, file ID is generated by file upload API. back: type: string format: base64-encoded example: >- data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4= description: >- The back of the document and must start with a prefix like "data:image/jpeg;base64," followed by the actual base64-encoded. back_file_id: type: string format: uuid example: 5135e6cc-28b6-4889-81dc-3b86a09e1395 description: >- The file ID of the back document, file ID is generated by file upload API. TosAcceptance: type: object description: > Details on the account's acceptance of the UQPAY Services Agreement. This property can only be updated for Custom accounts. required: - ip - date - user_agent properties: ip: type: string example: 0.0.0.0 description: > The IP address from which the account representative accepted their service agreement. format: ipv4 date: type: string format: date-time example: '2024-03-22T16:08:02+08:00' description: > The date when the account representative accepted their service agreement. user_agent: type: string example: >- Mozilla/5.0 (Macintosh; Intel Mac OS X x.y; rv:42.0) Gecko/20100101 Firefox/42.0 description: > The user agent of the browser from which the account representative accepted their service agreement. Phone: type: string example: '+6588880000' description: The phone number of the account. MonthlyEstimatedRevenue: type: object required: - amount - currency properties: amount: type: string example: TM001 description: | The total business income for the month and must be one of: * `TM001` - Less than 50,000. * `TM002` - 50,000 to 100,000. * `TM003` - 100,000 to 250,000. * `TM004` - 250,000 to 500,000. * `TM005` - Over 500,000. enum: - TM001 - TM002 - TM003 - TM004 - TM005 currency: type: string description: >- Currency code [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: | This field is mandatory and must be one of: * `VAT` - The VAT number of the company. * `TAX` - The business ID number of the company, as appropriate for the company's country. (Examples are an Employer ID Number in the U.S., a Business Number in Canada, or a Company Number in the UK.) * `GST` - The goods and services tax (GST) is a type of tax levied on most goods and services sold for domestic consumption in many countries. enum: - VAT - TAX - GST number: type: string description: >- The identifier number (e.g., VAT registration number, tax ID, or GST number). maxLength: 255 example: XXX-XX-XXXX FirstNameEnglish: type: string example: John description: >- The individual's first name in English. This should match the name shown on official English documents such as passport. LastNameEnglish: type: string example: Doe description: >- The individual's last name in English. This should match the name shown on official English documents such as passport. FirstName: type: string example: 三 description: The individual's first name in their native language. LastName: type: string example: 张 description: The individual's last name in their native language. LocalName: type: string example: 张三 description: Name in their native language. Nationality: type: string maxLength: 2 description: 2-letter ISO 3166-2 country code example: US DateOfBirth: type: string format: date example: '1990-01-01' description: The individual's date of birth in YYYY-MM-DD format. TaxNumber: type: string example: 123-45-6789 Internationally: type: integer enum: - 0 - 1 description: > Indicates whether the account will be involved in international transactions, including sending or receiving money across borders. - `0`: No - `1`: Yes BankingCurrencies: type: array description: The top 3 currencies you expect to send or receive. items: type: string example: USD BankingCountries: type: array description: The top 3 countries you expect to send or receive. items: type: string example: US OtherPurpose: type: string description: >- Required when `account_purpose = OTHERS`. Additional text to provide more information about the account purpose. IndividualAccountPurpose: type: array description: > Purposes of account usage. Select one or more applicable reasons for holding and using the account. If `others` is selected, please provide additional explanation. - `purchase`: Payments for personal needs with invoices. - `bill_payment`: Paying utility bills. - `educational_expenses`: Payments for tuition fees, accommodation, or other educational costs abroad. - `personal_remittance`: Funds sent to family or friends abroad for personal expenses. - `loan_repayment`: Transfers made to settle loans or debts in another country. - `investment`: Transfers related to investment activities, such as funding for foreign investments or investments in international financial products. - `charitable_donation`: Remittances sent for charitable causes or non-profit organizations in foreign countries. - `others`: Explain the purpose in details. 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: > Singapore citizenship status of the individual. Only applicable for Singapore-related accounts. - `non_resident`: Not a resident of Singapore. - `singapore_citizen`: Singapore citizen. - `permanent_resident`: Singapore 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: The type of identification document. IdentificationIdNumber: type: string example: A12345678 description: The ID number of the individual. IdentificationRemark: type: string example: Valid until 2030 NoTypeDocuments: type: object description: | A legal document used to verify identity. For each side (front/back), only one of `*_file_id`, `*` is required. properties: front: type: string format: base64-encoded example: >- data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4= description: >- The front of the document and must start with a prefix like "data:image/jpeg;base64," followed by the actual base64-encoded. front_file_id: type: string format: uuid example: 5135e6cc-28b6-4889-81dc-3b86a09e1395 description: >- The file ID of the front document, file ID is generated by file upload API. back: type: string format: base64-encoded example: >- data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4= description: >- The back of the document is required for all document types apart from passports and must start with a prefix like "data:image/jpeg;base64," followed by the actual base64-encoded. back_file_id: type: string format: uuid example: 5135e6cc-28b6-4889-81dc-3b86a09e1395 description: >- The file ID of the back document, file ID is generated by file upload API. securitySchemes: XAuthToken: type: apiKey in: header name: x-auth-token description: The API token for login provided by UQPay. ````