--- title: "Retrieve Account" method: GET path: "/v1/accounts/{id}" tags: ["Accounts"] --- # Retrieve Account `GET /v1/accounts/{id}` Retrieves the details of an account. ## Path parameters - `id` string, uuid, required ## Query parameters - `business_code` 'BANKING' | 'ACQUIRING' | 'ISSUING' ## Response `200` OK - Successfully retrieved an account details. - union - RetrieveAccountResponse — Information about the company or business. - `account_id` string — A unique identifier of the account. - `short_reference_id` string — The short reference ID of the account. - `business_code` string[] — The business type for the account. - `email` string, email — The email address of the account. - `account_name` string — The customer name of the account. - `country` string — Two-letter country code [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). - `status` string — 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. - `verification_status` 'VERIFIED' | 'UNDER_REVIEW' | 'ACTION_REQUIRED' — The KYC verification outcome for the cardholder associated with this card creation request. * `VERIFIED` - The cardholder's identity has been verified. * `UNDER_REVIEW` - AML or KYC review is in progress. * `ACTION_REQUIRED` - The cardholder must complete an action (such as Sumsub IDV) before the card can be activated. - `entity_type` 'COMPANY' | 'INDIVIDUAL' — Specifies the type of beneficiary entity to filter by. Valid values are: - `COMPANY` : corporate entities - `INDIVIDUAL` : personal accounts - `review_reason` string — The reason provided when the account review was not approved. - `contact_details` ContactDetails - `email` string, email, required — The email address of the account. This is only to make the account easier to identify to you. - `phone` string, required — The phone number of the account. - `business_details` BusinessDetails — Business information about the account. - `legal_entity_name` string — The official legal name of the company as registered with the relevant government authority. - `legal_entity_name_english` string, required — 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` string, required — The date when a company is legally formed. - `registration_number` string, required — 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` string, required — 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` string, required — 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` string, required — 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` 'BS001' | 'BS002' | 'BS003' | 'BS004' | 'BS005', required — 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. - `monthly_estimated_revenue` MonthlyEstimatedRevenue, required - `amount` 'TM001' | 'TM002' | 'TM003' | 'TM004' | 'TM005', required — 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. - `currency` string, required — Currency code [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes). - `account_purpose` string[], required — 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. - `identifier` EntityIdentifier - `type` 'VAT' | 'TAX' | 'GST' — 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. - `number` string — The identifier number (e.g., VAT registration number, tax ID, or GST number). - `website_url` string, uri — The business's publicly available website. - `registration_address` RegistrationAddress — The company's registration address. - `city` string, required — City, district, suburb, town, or village. - `line1` string, required — Address line 1 (e.g., street, PO Box, or company name). - `state` string — State or province two-letter ISO 3166 code. Only applicable to some countries, required where country code = "US", "CA" or "MX". - `line2` string — Address line 2 (e.g., apartment, suite, unit, or building). - `postal_code` string, required — ZIP or postal code. - `business_address` Address[] — The company's business address. - `country_code` string, required — The two-letter country code in ISO 3166-1 alpha-2 format. - `state` string — State or province of the address. Maximum of 100 characters. - Required when `country_code` is "US" or "CA". - `city` string, required — City of the address. Maximum of 100 characters. - `street` string, required — Street of the address. Maximum of 100 characters. - `postcode` string, required — Postcode of the address. Maximum of 10 characters. - `representatives` object[] — Information about the representatives of the company. - `representative_id` string, required — The unique identifier for the representative. - `roles` 'DIRECTOR' | 'BENEFICIAL_OWNER' | 'DIRECTOR_BENEFICIAL_OWNER', required — Roles of the business person. Any of `DIRECTOR`, `BENEFICIAL_OWNER`, `DIRECTOR_BENEFICIAL_OWNER`. - `first_name` string, required — The representative's first name. - `last_name` string, required — The representative's last name. - `nationality` string, required — Nationality of the representative. (2-letter ISO 3166-2 country code) - `date_of_birth` string, required — Birth date of the account's user in YYYY-MM-DD format. - `share_percentage` string — Share percentage of the account's user, required where roles != "DIRECTOR". - `identification` object, required — Identity document information for the representative. - `type` 'PASSPORT' | 'NATIONAL_ID' | 'DRIVERS_LICENSE', required — The type of identification. Enum `PASSPORT`,`NATIONAL_ID`,`DRIVERS_LICENSE`. - `id_number` string, required — The official ID number, as applicable in the representative's country. (For US, the Social Security Number) - `documents` DocumentsOnlyFrontAndBack, required — A legal document used to verify identity. - `front` string — The url of the front document. - `back` string — The url of the back document. - `residential_address` Address, required - `country_code` string, required — The two-letter country code in ISO 3166-1 alpha-2 format. - `state` string — State or province of the address. Maximum of 100 characters. - Required when `country_code` is "US" or "CA". - `city` string, required — City of the address. Maximum of 100 characters. - `street` string, required — Street of the address. Maximum of 100 characters. - `postcode` string, required — Postcode of the address. Maximum of 10 characters. - `as_applicant` boolean, required — The current representative is the authorized applicant of the company. - `other_doucments` object[] — Other documents, supports base64-encoded content or file id. - `type` 'PROOF_OF_ADDRESS' | 'OTHERS', required — Type of document. - `front` string, required — File reference. Supports base64-encoded content or a file ID issued by UQPAY. - `documents` DocumentsOnlyFrontAndBackWithType[] — The document to use to confirm the company's identity. - `type` string — The type of document. Enum `CERTIFICATE_OF_INCORPORATION`,`ARTICLES_OF_ASSOCIATION`, `SHAREHOLDING_STRUCTURE_CERTIFICATE`,`OTHERS`. - `front` string — The url of the front document. - `back` string — The url of the back document. - `tos_acceptance` object — Details on the account's acceptance of the UQPAY Services Agreement This property can only be updated for Custom accounts. - `ip` string, required — The IP address from which the account representative accepted their service agreement. - `date` string, required — The date when the account representative accepted their service agreement. - `user_agent` string, required — The user agent of the browser from which the account representative accepted their service agreement. - RetrieveIndividualAccountResponse — Information about the individual account. - `account_id` string — A unique identifier of the account. - `short_reference_id` string — The reference generated by the system to identify the entity. - `business_code` string[] — The business type for the account. - `account_name` string — The customer name of the account. - `status` string — 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. - `entity_type` 'COMPANY' | 'INDIVIDUAL' — Specifies the type of beneficiary entity to filter by. Valid values are: - `COMPANY` : corporate entities - `INDIVIDUAL` : personal accounts - `verification_status` 'VERIFIED' | 'UNDER_REVIEW' | 'ACTION_REQUIRED' — The KYC verification outcome for the cardholder associated with this card creation request. * `VERIFIED` - The cardholder's identity has been verified. * `UNDER_REVIEW` - AML or KYC review is in progress. * `ACTION_REQUIRED` - The cardholder must complete an action (such as Sumsub IDV) before the card can be activated. - `review_reason` string - `contact_details` ContactDetails - `email` string, email, required — The email address of the account. This is only to make the account easier to identify to you. - `phone` string, required — The phone number of the account. - `person_details` PersonDetails - `first_name_english` string — The individual's first name in English. This should match the name shown on official English documents such as passport. - `last_name_english` string — The individual's last name in English. This should match the name shown on official English documents such as passport. - `first_name` string — First name of the beneficiary, only exist when the entity_type is INDIVIDUAL. - When `payment_method = SWIFT`: * Only English letters, numbers, special characters (half-width format), and spaces can be included. * Allowed special characters: `-_().,@#~ ! $ % ^ & * + = { } [ ] \ | : " ' < > ? /・……` - When `payment_method = LOCAL`: * No strict validation rules apply, local language characters are supported. - No need to pass this field when `bank_details.bank_country_code = SG` & `bank_details.account_currency_code = SGD` - `last_name` string — Last name of the beneficiary, only exist when the entity_type is INDIVIDUAL. - When `payment_method = SWIFT`: * Only English letters, numbers, special characters (half-width format), and spaces can be included. * Allowed special characters: `-_().,@#~ ! $ % ^ & * + = { } [ ] \ | : " ' < > ? /・……` - When `payment_method = LOCAL`: * No strict validation rules apply, local language characters are supported. - No need to pass this field when `bank_details.bank_country_code = SG` & `bank_details.account_currency_code = SGD` - `local_name` string — Name in their native language. - `nationality` string — The cardholder's nationality in ISO 3166-1 alpha-2 format. Required for STANDARD and ENHANCED KYC levels. - `date_of_birth` string, date — The individual's date of birth in YYYY-MM-DD format. - `tax_number` string - `internationally` 0 | 1 — Indicates whether the account will be involved in international transactions, including sending or receiving money across borders. - `0`: No - `1`: Yes - `banking_currencies` string[] — The top 3 currencies you expect to send or receive. - `banking_countries` string[] — The top 3 countries you expect to send or receive. - `monthly_estimated_revenue` MonthlyEstimatedRevenue - `amount` 'TM001' | 'TM002' | 'TM003' | 'TM004' | 'TM005', required — 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. - `currency` string, required — Currency code [ISO_4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes). - `other_purpose` string — Required when `account_purpose = OTHERS`. Additional text to provide more information about the account purpose. - `account_purpose` string[] — 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. - `identification` IndividualIdentification - `type` 'PASSPORT' | 'DRIVERS_LICENSE' | 'NATIONAL_ID' | 'NRIC' | 'CERTIFICATE_OF_INCORPORATION', required — Type of identification of the payer. - `PASSPORT`: Official international travel document issued by a government authority. - `DRIVERS_LICENSE`: Official driving permit issued by a government transportation authority. - `NATIONAL_ID`: Government-issued identification document for citizen verification. - `NRIC`: Singapore National Registration Identity Card for residents. - `CERTIFICATE_OF_INCORPORATION`: Official document proving a company's registered status and existence. - `id_number` string, required — The ID number of the individual. - `remark` string - `citizenship_status` 'non_resident' | 'singapore_citizen' | 'permanent_resident' — 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. - `documents` NoTypeDocuments, required — A legal document used to verify identity. For each side (front/back), only one of `*_file_id`, `*` is required. - `front` string, base64-encoded — 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` string, uuid — The file ID of the front document, file ID is generated by file upload API. - `back` string, base64-encoded — 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` string, uuid — The file ID of the back document, file ID is generated by file upload API. - `residential_address` Address - `country_code` string, required — The two-letter country code in ISO 3166-1 alpha-2 format. - `state` string — State or province of the address. Maximum of 100 characters. - Required when `country_code` is "US" or "CA". - `city` string, required — City of the address. Maximum of 100 characters. - `street` string, required — Street of the address. Maximum of 100 characters. - `postcode` string, required — Postcode of the address. Maximum of 10 characters. - `documents` IndividualDocuments[] — Identity verification documents submitted for the individual account. - `type` 'PROOF_OF_ADDRESS' | 'SOURCE_OF_FUNDS' | 'PROOF_OF_POSITION_AND_INCOME' | 'OTHERS', required — 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. - `front` string, base64-encoded — 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` string, uuid — The file ID of the front document, file ID is generated by file upload API. - `back` string, base64-encoded — 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` string, uuid — The file ID of the back document, file ID is generated by file upload API. - `tos_acceptance` TosAcceptance — Details on the account's acceptance of the UQPAY Services Agreement. This property can only be updated for Custom accounts. - `ip` string, ipv4, required — The IP address from which the account representative accepted their service agreement. - `date` string, date-time, required — The date when the account representative accepted their service agreement. - `user_agent` string, required — The user agent of the browser from which the account representative accepted their service agreement. --- [API](https://skmtc.dev/uqpay/apis/authentication-api.md) · [All operations](https://skmtc.dev/uqpay/apis/authentication-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/uqpay/authentication-api/revisions/cef532a10777/schema)