THIS SITE IS UNDER CONSTRUCTION

Deriv Core API

Create Client Tax Information

Developing

POST

/client/tax-information

create_client_tax_information

Last modified:2025-03-12 04:11:41

Request

Header Params

Authorization

string

optional

Example:

x-client-id

string

optional

Optional only required for internal systems referrence.

Default:

Body Params application/json

financial_assessment

object

required

industry_of_employment

string

required

occupation

string

required

tax_identification_number

string

required

tax_residence

string

required

is_foreign_taxpayer

boolean

required

employment_status

string

required

Example

{
  "financial_assessment": {
    "industry_of_employment": "medical",
    "occupation": "nurse"
  },
  "tax_identification_number": "XR2354F5",
  "tax_residence": "ae",
  "is_foreign_taxpayer": false,
  "employment_status": "employed"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/client/tax-information' \
--header 'Authorization: {{CLIENT_AUTH_TOKEN}}' \
--header 'x-client-id: {{RL_EXCLUSION_KEY}}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "financial_assessment": {
    "industry_of_employment": "medical",
    "occupation": "nurse"
  },
  "tax_identification_number": "XR2354F5",
  "tax_residence": "ae",
  "is_foreign_taxpayer": false,
  "employment_status": "employed"
}'

Responses

🟢200OK

application/json

Body

data

array [object {10}]

required

client_id

integer

optional

employment_status

string

optional

tax_residence

string

optional

tax_identification_number

string

optional

is_foreign_taxpayer

boolean

optional

financial_assessment

object

optional

schema_version

integer

optional

created_time

string

optional

updated_time

null

optional

account_opening_reason

null

optional

meta

object

required

endpoint

string

required

method

string

required

timing

integer

required

Example

{
  "data": [
    {
      "client_id": 61,
      "employment_status": "employed",
      "tax_residence": "ae",
      "tax_identification_number": "XR2354F5",
      "is_foreign_taxpayer": false,
      "financial_assessment": {
        "occupation": "nurse",
        "industry_of_employment": "medical"
      },
      "schema_version": 1,
      "created_time": "2025-03-12T04:11:44.824044",
      "updated_time": null,
      "account_opening_reason": null
    }
  ],
  "meta": {
    "endpoint": "/client/tax-information",
    "method": "POST",
    "timing": 2561
  }
}

Modified at 2025-03-12 04:11:41

Get Client Tax Information

Update Client Tax Information