Get KYB/KYC submit + open account status

Purpose
Query Sumsub / RD onboarding progress and whether the HKD VA is ready to trade.

Usage
Query: externalUserId or userId — one required; if both are sent, userId wins.
Use persons[].redirectLink (Sumsub) or channelRedirectLink (RD H5) when returned.
verificationStatus=Pass + non-null virtualAccountId ⇒ ready for trading.

API Key

Add parameter in header

API-KEY

Example:

API-KEY: ********************

API Key

Add parameter in header

API-SIGNATURE

Example:

API-SIGNATURE: ********************

API Key

Add parameter in header

API-TIMESTAMP

Example:

API-TIMESTAMP: ********************

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Bodyapplication/json

Examples

SuccessWaiting submit

{
    "status": 200,
    "code": null,
    "msg": "OK",
    "data": {
        "subUserId": "21000000000632",
        "externalUserId": "merchant_user_offramp_001",
        "kycStatus": "Pass",
        "verificationStatus": "Pass",
        "verificationFailReason": null,
        "channelUserId": "HKL260724001050",
        "channelRedirectLink": "Success",
        "virtualAccountId": 21942,
        "persons": [
            {
                "subUserId": "21000000000632",
                "uid": "21000000000633",
                "name": "John Doe",
                "kycStatus": "Pass",
                "identityStatus": "Pass",
                "poaStatus": "Pass",
                "livenessCheckStatus": "Pass",
                "screeningStatus": "Pass",
                "verificationLevelName": "BPN-CORP-USER",
                "verificationToken": null,
                "channelUserId": null,
                "redirectLink": null
            }
        ]
    },
    "traceId": "Auto:af0b6dbbaf13467f84917fcb6ef01cd3",
    "success": true
}