Skip to main content
GET

Authorizations

BIZ-API-KEY
string
header
required

The API key. For more details, refer to API key.

In the API playground, enter your API secret, and your API key will be accordingly calculated.

Path Parameters

merchant_id
string
required

The merchant ID.

Response

The request was successful.

kyc_submission_id
string<uuid>
required

The KYC submission ID.

Example:

"f47ac10b-58cc-4372-a567-0e02b2c3d479"

merchant_id
string
required

The merchant ID.

Example:

"M1001"

status
enum<string>
required

The KYC submission status. Possible values include:

  • PendingReview: The KYC submission is pending review.
  • Completed: The KYC submission has been completed.
  • Failed: The KYC submission has failed.
Available options:
PendingReview,
Completed,
Failed
Example:

"PendingReview"

email
string
required

The merchant email address.

phone
string
required

The merchant phone number.

Example:

"+85212345678"

merchant_type
enum<string>
required

The merchant type. Possible values include:

  • B2B: Business-to-business merchant.
  • B2C: Business-to-consumer merchant.
Available options:
B2B,
B2C
Example:

"B2B"

country
string
required

The country/region of the merchant, in ISO 3166-1 alpha-3 format.

Example:

"HKG"

industry
string[]
required

The industry categories of the merchant.

Example:
company_info
object
required
created_timestamp
integer<int64>
required

The creation timestamp in Unix seconds.

Example:

1744689600

updated_timestamp
integer<int64>

The last update timestamp in Unix seconds.

Example:

1744689600