THIS SITE IS UNDER CONSTRUCTION

Deriv Core API

Get Onboarding Status

Testing

GET

/client/onboarding-status

get_onboarding_status

Last modified:2025-02-06 08:23:16

Request

Header Params

Authorization

string

optional

Example:

x-client-id

string

optional

Optional only required for internal systems referrence.

Default:

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET '/client/onboarding-status' \
--header 'Authorization: {{CLIENT_AUTH_TOKEN}}' \
--header 'x-client-id: {{RL_EXCLUSION_KEY}}'

Responses

🟢200Success

application/json

Body

data

array [object {6}]

required

profile

object

optional

address

object

optional

wallet

object

optional

tnc

object

optional

deposit

object

optional

mt5_accounts

object

optional

meta

object

required

endpoint

string

required

method

string

required

timing

integer

required

Example

{
  "data": [
    {
      "profile": {
        "status": "complete"
      },
      "address": {
        "status": "complete"
      },
      "wallet": {
        "created": false
      },
      "tnc": {
        "accepted": true
      },
      "deposit": {
        "status": "incomplete"
      },
      "mt5_accounts": {
        "demo": {
          "created": false
        },
        "real": {
          "created": false
        }
      }
    }
  ],
  "meta": {
    "endpoint": "/client/onboarding-status",
    "method": "GET",
    "timing": 572
  }
}

Modified at 2025-02-06 08:23:16

Get Client System Status

Create TNC