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. Currency is required
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

WAITING/person submitWAITING/channel redirectSUCCESS

{
    "status": 200,
    "code": null,
    "msg": "OK",
    "data": {
        "subUserId": "21000000000632",
        "externalUserId": "merchant_user_offramp_001",
        "currency": "HKD",
        "status": "WAITING",
        "requestId": "ONB-OFFRAMP-1787315173",
        "virtualAccountId": null,
        "sharingProcessed": true,
        "failReason": null,
        "accountName": null,
        "accountNumber": null,
        "bankCode": null,
        "bankBranchCode": null,
        "bankIspb": null,
        "bankName": null,
        "bankAddress": null,
        "iban": null,
        "bic": null,
        "reference": null,
        "channelRedirectLink": null,
        "persons": [
            {
                "subUserId": "21000000000632",
                "uid": "21000000000633",
                "name": "Alice Wong",
                "kycStatus": "Pending",
                "identityStatus": "Pending",
                "poaStatus": "Pending",
                "livenessCheckStatus": "Pending",
                "screeningStatus": "Pending",
                "verificationLevelName": "BPN-CORP-USER",
                "verificationToken": "<VERIFICATION_TOKEN>",
                "redirectLink": "https://verify.example.com/session/example"
            }
        ]
    },
    "traceId": "Auto:example",
    "success": true
}