Share KYB/KYC and open account directly

Purpose
Submit KYB data to open an RD Wallet HKD sub-account (whitelistedBusiness: OFFRAMP | ONRAMP | ALL).

Usage
Required: requestId, externalUserId, whitelistedBusiness, currency (HKD), profile.
OFFRAMP / ALL: profile.extra.bankAccounts required (≥1 account).
ONRAMP: bank accounts optional.
Merchant identity comes from API-KEY; do not send platform masterUserId.

Request

Authorization

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

Body Params application/jsonRequired

Examples

OFFRAMP - HK Limited CompanyONRAMP — HK Limited CompanyALL — HK Limited CompanyONRAMP — Individual Account

{
    "requestId": "ONB-OFFRAMP-1787315173",
    "externalUserId": "merchant_user_offramp_001",
    "email": "ops@example.com",
    "whitelistedBusiness": "OFFRAMP",
    "currency": "HKD",
    "profile": {
        "userType": "Corporate",
        "company": {
            "legalEntityTypeCode": 1,
            "incorporationCountry": "HKG",
            "registrationNumber": "4862430",
            "incorporationCertificateFile": "<FILE_REF_OR_BASE64>",
            "incorporationDate": "2022-05-01",
            "registrationCountry": "HKG",
            "registeredAddress": "Units 2801-05A, Level 28, K11 Atelier, Hong Kong",
            "operatingCountry": "HKG",
            "operatingAddress": "Units 2801-05A, Level 28, K11 Atelier, Hong Kong",
            "companyName": "Sample Trading Limited",
            "financialInstitutionFlag": 2,
            "listedFlag": 2,
            "governmentOwnedFlag": 2,
            "memorandumFiles": [
                "<FILE_REF_OR_BASE64>"
            ]
        },
        "business": {
            "items": [
                {
                    "industryCode": "I300734",
                    "yearsInBusiness": "3",
                    "operatingCountries": [
                        "HKG"
                    ],
                    "lastYearSales": "2",
                    "businessDescription": "Cross-border digital asset payment service"
                }
            ]
        },
        "shareholder": {
            "structureDiagramFiles": [
                "<FILE_REF_OR_BASE64>"
            ]
        },
        "ubo": {
            "directorCount": 2,
            "members": [
                {
                    "firstName": "Alice",
                    "lastName": "Wong",
                    "gender": 2,
                    "dateOfBirth": "1985-06-20",
                    "nationality": "HKG",
                    "idType": 2,
                    "idNumber": "B2345678",
                    "email": "alice.wong@example.com",
                    "director": true,
                    "beneficialOwner": true,
                    "mandateUser": true,
                    "walletAdmin": true,
                    "ownershipPercent": 60,
                    "shareToken": "<PARTNER_SUMSUB_SHARE_TOKEN>",
                    "idDocumentFiles": [
                        "<FILE_REF_OR_BASE64>"
                    ]
                },
                {
                    "firstName": "Bob",
                    "lastName": "Lee",
                    "gender": 1,
                    "dateOfBirth": "1983-11-08",
                    "nationality": "HKG",
                    "idType": 2,
                    "idNumber": "C3456789",
                    "email": "bob.lee@example.com",
                    "director": true,
                    "beneficialOwner": true,
                    "mandateUser": false,
                    "walletAdmin": false,
                    "ownershipPercent": 40,
                    "idDocumentFiles": [
                        "<FILE_REF_OR_BASE64>"
                    ]
                }
            ]
        },
        "extra": {
            "bankAccounts": [
                {
                    "accountName": "Sample Trading Limited",
                    "accountNo": "123456789",
                    "bankId": "004"
                }
            ]
        }
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

cURL

OFFRAMP - HK Limited CompanyONRAMP — HK Limited CompanyALL — HK Limited CompanyONRAMP — Individual Account

curl --location '/v1/kyb/onboarding-sharing' \
--header 'API-KEY: <api-key>' \
--header 'API-SIGNATURE: <api-key>' \
--header 'API-TIMESTAMP: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "requestId": "ONB-OFFRAMP-1787315173",
    "externalUserId": "merchant_user_offramp_001",
    "email": "ops@example.com",
    "whitelistedBusiness": "OFFRAMP",
    "currency": "HKD",
    "profile": {
        "userType": "Corporate",
        "company": {
            "legalEntityTypeCode": 1,
            "incorporationCountry": "HKG",
            "registrationNumber": "4862430",
            "incorporationCertificateFile": "<FILE_REF_OR_BASE64>",
            "incorporationDate": "2022-05-01",
            "registrationCountry": "HKG",
            "registeredAddress": "Units 2801-05A, Level 28, K11 Atelier, Hong Kong",
            "operatingCountry": "HKG",
            "operatingAddress": "Units 2801-05A, Level 28, K11 Atelier, Hong Kong",
            "companyName": "Sample Trading Limited",
            "financialInstitutionFlag": 2,
            "listedFlag": 2,
            "governmentOwnedFlag": 2,
            "memorandumFiles": [
                "<FILE_REF_OR_BASE64>"
            ]
        },
        "business": {
            "items": [
                {
                    "industryCode": "I300734",
                    "yearsInBusiness": "3",
                    "operatingCountries": [
                        "HKG"
                    ],
                    "lastYearSales": "2",
                    "businessDescription": "Cross-border digital asset payment service"
                }
            ]
        },
        "shareholder": {
            "structureDiagramFiles": [
                "<FILE_REF_OR_BASE64>"
            ]
        },
        "ubo": {
            "directorCount": 2,
            "members": [
                {
                    "firstName": "Alice",
                    "lastName": "Wong",
                    "gender": 2,
                    "dateOfBirth": "1985-06-20",
                    "nationality": "HKG",
                    "idType": 2,
                    "idNumber": "B2345678",
                    "email": "alice.wong@example.com",
                    "director": true,
                    "beneficialOwner": true,
                    "mandateUser": true,
                    "walletAdmin": true,
                    "ownershipPercent": 60,
                    "shareToken": "<PARTNER_SUMSUB_SHARE_TOKEN>",
                    "idDocumentFiles": [
                        "<FILE_REF_OR_BASE64>"
                    ]
                },
                {
                    "firstName": "Bob",
                    "lastName": "Lee",
                    "gender": 1,
                    "dateOfBirth": "1983-11-08",
                    "nationality": "HKG",
                    "idType": 2,
                    "idNumber": "C3456789",
                    "email": "bob.lee@example.com",
                    "director": true,
                    "beneficialOwner": true,
                    "mandateUser": false,
                    "walletAdmin": false,
                    "ownershipPercent": 40,
                    "idDocumentFiles": [
                        "<FILE_REF_OR_BASE64>"
                    ]
                }
            ]
        },
        "extra": {
            "bankAccounts": [
                {
                    "accountName": "Sample Trading Limited",
                    "accountNo": "123456789",
                    "bankId": "004"
                }
            ]
        }
    }
}'

Responses

🟢200Success

application/json

Bodyapplication/json

Example

{
    "status": 200,
    "code": null,
    "msg": "OK",
    "data": {
        "success": true,
        "userId": "21000000000632",
        "accountId": "21000000000632",
        "externalUserId": "merchant_user_offramp_001",
        "requestId": "ONB-OFFRAMP-1787315173",
        "sharingProcessed": true,
        "failReason": null
    },
    "traceId": "Auto:8e06c7e806ac4a49b509575e2ab66e28",
    "success": true
}