THIS SITE IS UNDER CONSTRUCTION

Initiate Cooldown Status

Core Prod

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

POST

/client/cooldown-status

Last modified:2025-07-14 06:45:08

This endpoint can be used to set the cooldown status for a specific client, indicating whether the client is currently restricted from real account trading (e.g., due to failed suitability or compliance reasons).

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api-core.deriv.com/v1/client/cooldown-status' \
--header 'Authorization: ' \
--header 'Content-Type: application/json' \
--data-raw '{"status":"rejected"}'

Response Example

200 - Success

{
    "data": [
        {
            "id": 1625,
            "client_id": 1615,
            "status_code": "cool_down",
            "staff_identifier": "api",
            "reason": "rejected trading suitability",
            "created_time": "2025-07-14T03:05:27.066126",
            "updated_time": "2025-07-14T06:41:02.765915"
        }
    ],
    "meta": {
        "timing": 237,
        "endpoint": "/v1/client/cooldown-status",
        "method": "POST"
    }
}

Request

Header Params

Authorization

string

required

Example:

Body Params application/json

status

required

Status of the trading assessment review. Can be either 'accepted' or 'rejected'.

One of

Accepted

Rejected

Allowed value:

accepted

Examples

Responses

🟢200OK

application/json

Body

data

array [object {7}]

required

List of client cooldown status records.

integer

required

Unique identifier of the cooldown status record.

client_id

integer

required

Unique identifier of the client.

status_code

string

required

Status of the client, e.g., 'cool_down'.

staff_identifier

string

required

Identifier of the staff or source that triggered the cooldown status (e.g., 'api').

reason

string

required

Reason for setting the cooldown status.

created_time

string <date-time>

required

Timestamp when the cooldown status was created.

updated_time

string <date-time>

required

Timestamp when the cooldown status was last updated.