Skip to main content
POST
Create SubAccount

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.

Information about the individual applying for the account.

entity_type
enum<string>
required

The type of entity for the account.

Available options:
COMPANY,
INDIVIDUAL
Example:

"COMPANY"

nickname
string
required

Nickname for the account.

Maximum string length: 100
Example:

"MyTechCorp"

individual_info
object

Personal information for individual account registration.

  • Required when entity_type is INDIVIDUAL.
  • gender and annual_income are required for individual SubAccounts created on or after 2026-07-02.
identity_verification
object

Identity verification information for individuals.

  • Required when entity_type is INDIVIDUAL.
expected_activity
object
  • Required when entity_type is INDIVIDUAL.
proof_documents
object
  • Required when entity_type is INDIVIDUAL.
tos_acceptance
object

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

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.

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.

Available options:
APPROVED,
PENDING,
REJECT,
EXPIRED,
RETURN
Example:

"APPROVED"