THIS SITE IS UNDER CONSTRUCTION

Get Onboarding Status

Core Prod

https://api-core.deriv.com/v1

GET

/client/onboarding-status

Last modified:2025-09-04 08:07:08

This endpoint allows you to check the onboarding status of a partner. It returns information about the current stage of the onboarding process, any required actions, and whether the partner is eligible for full account access. Use this endpoint to track and guide clients through onboarding steps such as identity verification, documentation submission.

Request

Header Params

Responses

🟢200Success

application/json

Body

🟠401Unauthorized

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api-core.deriv.com/v1/client/onboarding-status' \
--header 'Authorization: '

Response Example

200 - Success

{
    "data": [
        {
            "profile": {
                "status": "incomplete"
            },
            "address": {
                "status": "incomplete"
            },
            "wallet": {
                "created": false
            },
            "tnc": {
                "accepted": false
            },
            "deposit": {
                "status": "incomplete"
            },
            "mt5_accounts": {
                "demo": {
                    "created": false
                },
                "real": {
                    "created": false
                }
            },
            "kyc": {
                "poa_status": "unverified",
                "poi_status": "unverified",
                "main_status": "unverified"
            },
            "system": {
                "status": "needs_kyc_verification"
            },
            "verification": {
                "email_verified": true,
                "phone_verified": true
            }
        }
    ],
    "meta": {
        "endpoint": "/v1/client/onboarding-status",
        "method": "GET",
        "timing": 2580
    }
}

Modified at 2025-09-04 08:07:08

Create Client Profile

Create TNC