Create Account

Create an account so they can start receiving payments. Once created, we will run due diligence checks. Please note that currently this API is only for Banking accounts.

POST /v1/accounts

Create Account

cURL

curl --request POST \
  --url https://api-sandbox.uqpaytech.com/api/v1/accounts \
  --header 'Content-Type: application/json' \
  --header 'x-auth-token: <api-key>' \
  --data '
{
  "entity_type": "INDIVIDUAL",
  "name": "John Doe",
  "contact_details": {
    "email": "[e-mail]",
    "phone": "[phone]"
  },
  "person_details": {
    "first_name_english": "John",
    "last_name_english": "Doe",
    "nationality": "US",
    "date_of_birth": "1990-01-01",
    "banking_currencies": [
      "USD"
    ],
    "banking_countries": [
      "US"
    ],
    "monthly_estimated_revenue": {
      "amount": "TM001",
      "currency": "SGD"
    },
    "account_purpose": [],
    "identification": {
      "type": "PASSPORT",
      "id_number": "A12345678",
      "documents": {
        "front": "data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=",
        "front_file_id": "5135e6cc-28b6-4889-81dc-3b86a09e1395",
        "back": "data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=",
        "back_file_id": "5135e6cc-28b6-4889-81dc-3b86a09e1395"
      },
      "remark": "Valid until 2030",
      "citizenship_status": "non_resident"
    },
    "first_name": "三",
    "last_name": "张",
    "local_name": "张三",
    "tax_number": "123-45-6789",
    "other_purpose": "<string>"
  },
  "residential_address": {
    "city": "Singapore",
    "country": "SG",
    "line1": "9 N Buona Vista Dr",
    "state": "SG",
    "postal_code": "138666",
    "line2": "THE METROPOLIS"
  },
  "documents": [
    {
      "type": "PROOF_OF_ADDRESS",
      "front": "data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=",
      "front_file_id": "5135e6cc-28b6-4889-81dc-3b86a09e1395",
      "back": "data:image/png;base64,TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4=",
      "back_file_id": "5135e6cc-28b6-4889-81dc-3b86a09e1395"
    }
  ],
  "tos_acceptance": {
    "ip": "0.0.0.0",
    "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"
  }
}
'

200

{
  "account_id": "f5bb6498-552e-40a5-b14b-616aa04ac1c1",
  "short_reference_id": "P220406-LLCVLRM",
  "status": "PROCESSING",
  "verification_status": "APPROVED"
}

Authorizations

x-auth-token · string · header · required

The API token for login provided by UQPay.

Body

application/json

Select one of the following entity type.

Individual Account

Company Account

Information about the individual applying for the account. This field is available for INDIVIDUAL.

entity_type · enum<string> · required

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

Example:

"INDIVIDUAL"

name · string · required

Nickname, will be displayed in the Dashboard when selecting account.

Example:

"John Doe"

contact_details · object · required

Show child attributes

person_details · object · required

Personal information of the individual account holder.

Show child attributes

residential_address · object · required

Show child attributes

documents · object[] · required

Identity verification documents submitted for the individual account.

Show child attributes

tos_acceptance · object · required

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

Show child attributes

Response

200 - application/json

Account creation successfully.

account_id · string · required

A unique identifier of the account.

Example:

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

short_reference_id · string · required

The short reference ID of the account.

Example:

"P220406-LLCVLRM"

status · string · required

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> · required

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"