Skip to main content
GET
Retrieve Account

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

200 - application/json

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

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"

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.