Skip to main content
GET
/
v1
/
accounts
/
{id}
Retrieve Account
curl --request GET \
  --url https://api-sandbox.uqpaytech.com/api/v1/accounts/{id} \
  --header 'x-auth-token: <api-key>'
{
  "account_id": "f5bb6498-552e-40a5-b14b-616aa04ac1c1",
  "short_reference_id": "P220406-LLCVLRM",
  "business_code": [
    "BANKING"
  ],
  "email": "example@company.com",
  "account_name": "UQPAY PTE LTD.",
  "country": "US",
  "status": "PROCESSING",
  "verification_status": "APPROVED",
  "entity_type": "COMPANY",
  "review_reason": "The account is not compliant with the company's policies.",
  "contact_details": {
    "email": "example@company.com",
    "phone": "+6588880000"
  },
  "business_details": {
    "legal_entity_name_english": "UQPAY PTE LTD.",
    "incorporation_date": "2013-04-15",
    "registration_number": "201901754K",
    "business_structure": "SOLE_PROPRIETOR",
    "product_description": "Design and produce high-tech wireless headphones.",
    "merchant_category_code": "5733",
    "estimated_worker_count": "BS001",
    "monthly_estimated_revenue": {
      "amount": "TM001",
      "currency": "SGD"
    },
    "account_purpose": [
      "PAYOUT"
    ],
    "legal_entity_name": "ソフトバンクインターナショナル株式会社",
    "identifier": {
      "type": "VAT",
      "number": "XXX-XX-XXXX"
    },
    "website_url": "https://yourcompany.com"
  },
  "registration_address": {
    "city": "San Francisco",
    "line1": "9 N Buona Vista Dr",
    "postal_code": "94103",
    "state": "CA",
    "line2": "THE METROPOLIS"
  },
  "business_address": [
    {
      "city": "Singapore",
      "country": "SG",
      "line1": "9 N Buona Vista Dr",
      "state": "SG",
      "postal_code": "138666",
      "line2": "THE METROPOLIS"
    }
  ],
  "representatives": [
    {
      "representative_id": "72970a7c-7921-431c-b95f-3438724ba16f",
      "roles": "DIRECTOR",
      "first_name": "Mock",
      "last_name": "Toy",
      "nationality": "SG",
      "date_of_birth": "2024-01-28",
      "identification": {
        "type": "PASSPORT",
        "id_number": "27738277K",
        "documents": {
          "front": "https://files.uqpaytech.com/api/v1/files/f715f7e6-eef8-49de-b333-d95847d9e130/20241105/WX20231213-141835@2x.png",
          "back": "https://files.uqpaytech.com/api/v1/files/f715f7e6-eef8-49de-b333-d95847d9e130/20241105/WX20231213-141835@2x.png"
        }
      },
      "residential_address": {
        "city": "Singapore",
        "country": "SG",
        "line1": "9 N Buona Vista Dr",
        "state": "SG",
        "postal_code": "138666",
        "line2": "THE METROPOLIS"
      },
      "as_applicant": false,
      "share_percentage": "20.01",
      "other_doucments": [
        {
          "type": "PROOF_OF_ADDRESS",
          "front": "b3d9d2d5-4c12-4946-a09d-953e82sed2b0"
        }
      ]
    }
  ],
  "documents": [
    {
      "type": "CERTIFICATE_OF_INCORPORATION",
      "front": "https://files.uqpaytech.com/api/v1/files/f715f7e6-eef8-49de-b333-d95847d9e130/20241105/WX20231213-141835@2x.png",
      "back": "https://files.uqpaytech.com/api/v1/files/f715f7e6-eef8-49de-b333-d95847d9e130/20241105/WX20231213-141835@2x.png"
    }
  ],
  "tos_acceptance": {
    "ip": "127.0.0.1",
    "date": "2024-03-22T16:08:02+08:00",
    "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X x.y; rv:42.0) Gecko/20100101 Firefox/42.0"
  }
}

Authorizations

​
x-auth-token
string
header
required

The API token for login provided by UQPay.

Path Parameters

​
id
string<uuid>
required

Universally unique identifier (UUID v4) of a resource.

Example:

"b3d9d2d5-4c12-4946-a09d-953e82sed2b0"

Query Parameters

​
business_code
enum<string>

Business type code. Default to BANKING.

Available options:
BANKING,
ACQUIRING,
ISSUING

Response

OK - Successfully retrieved an account details.

Information about the company or business.

​
account_id
string

A unique identifier of the account.

Example:

"f5bb6498-552e-40a5-b14b-616aa04ac1c1"

​
short_reference_id
string

The short reference ID of the account.

Example:

"P220406-LLCVLRM"

​
business_code
enum<string>[]

The business type for the account.

Available options:
BANKING,
ACQUIRING,
ISSUING,
RAMP
Example:
["BANKING"]
​
email
string<email>

The email address of the account.

Maximum string length: 100
Example:

"example@company.com"

​
account_name
string

The customer name of the account.

Example:

"UQPAY PTE LTD."

​
country
string

Two-letter country code ISO 3166-1 alpha-2.

Maximum string length: 2
Example:

"US"

​
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.
Example:

"PROCESSING"

​
verification_status
enum<string>

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.
Available options:
APPROVED,
PENDING,
REJECT,
EXPIRED,
RETURN
Example:

"APPROVED"

​
entity_type
enum<string>

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.
Available options:
COMPANY,
INDIVIDUAL
​
review_reason
string

The reason provided when the account review was not approved.

Example:

"The account is not compliant with the company's policies."

​
contact_details
object
​
business_details
object

Business information about the account.

​
registration_address
object

The company’s registration address.

​
business_address
object[]

The company’s business address.

​
representatives
object[]

Information about the representatives of the company.

​
documents
object[]

The document to use to confirm the company's identity.

​
tos_acceptance
object

Details on the account’s acceptance of the UQPAY Services Agreement This property can only be updated for Custom accounts.