Get Client System Statuses

Testing

GET

/config/client-system-status

get_client_system_statuses

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

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'https://api-core.deriv.com/v1/config/client-system-status?status={{$helpers.arrayElement(['\''enabled'\'','\''disabled'\'','\''closed'\'','\''wind_down'\'','\''needs_kyc_verification'\'','\''wallets_disabled'\'','\''accounts_disabled'\''])}}' \
--header 'x-api-key: {{CHAMPION_API_KEY}}' \
--header 'Authorization: {{CLIENT_AUTH_TOKEN}}' \
--header 'x-client-id: {{RL_EXCLUSION_KEY}}'

Response Example

200 - Success

{
  "data": [
    {
      "client_system_status": {
        "statuses": [
          "enabled",
          "disabled",
          "closed",
          "wind_down",
          "needs_kyc_verification",
          "wallets_disabled",
          "accounts_disabled"
        ]
      }
    }
  ],
  "meta": {
    "endpoint": "/config/client-system-status",
    "method": "GET",
    "timing": 400
  }
}

Request

Query Params

status

string

optional

status

Example:

{{$helpers.arrayElement(['enabled','disabled','closed','wind_down','needs_kyc_verification','wallets_disabled','accounts_disabled'])}}

Header Params

x-api-key

string

required

Example:

Authorization

string

optional

Example:

x-client-id

string

optional

Optional only required for internal systems referrence.

Default:

Responses

🟢200OK

application/json

Body

data

array [object {1}]

required

client_system_status

object

optional