inquiry onboard status

Request

Authorization

API Key

Add parameter in header

X-BPN-API-KEY

Example:

X-BPN-API-KEY: ********************

API Key

Add parameter in header

X-BPN-SIGNATURE

Example:

X-BPN-SIGNATURE: ********************

API Key

Add parameter in header

X-BPN-TIMESTAMP

Example:

X-BPN-TIMESTAMP: ********************

or

Query Params

Request Code Samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location '/api/v1/onboarding/status?partner_user_id=undefined&bpn_user_id=undefined' \
--header 'X-BPN-API-KEY: <api-key>' \
--header 'X-BPN-SIGNATURE: <api-key>' \
--header 'X-BPN-TIMESTAMP: <api-key>'

Responses

🟢200

application/json

统一响应信封

Bodyapplication/json

Example

{
    "code": "SUCCESS",
    "message": "ok",
    "data": {
        "partner_user_id": "string",
        "bpn_user_id": "string",
        "channel_user_id": "string",
        "customer_type": "INDIVIDUAL",
        "onboarding_status": "NOT_ONBOARDED",
        "can_trade": true,
        "supported_business_types": [
            "ON_RAMP"
        ],
        "deposit_address_ready": true,
        "va_account_ready": true,
        "fail_code": "string",
        "fail_reason": "string",
        "updated_at": "2019-08-24T14:15:22.123Z"
    },
    "trace_id": "b7c1f0c2-3f0a-4e9b-9c2a-2b1d9d6f0a11"
}