API changes – immutable_fields

michael_mueller · September 2020

Dear developers,

We'll be adding a new key – 'immutable_fields' – to the 'get_settings' API response. The new key will contain a list of fields that can no longer be edited (read-only) due to landing company regulations and current account status. This will happen during the week starting 5th of October 2020.

Before the change
API response:

"get_settings": {
    "first_name": "Tom",
    "last_name": "Sawyer",
    ...
}

After the change
API response:

"get_settings": {
   "first_name": "Tom",
   "last_name": "Sawyer",
   ...
   "immutable_fields": [
        "residence",
         "date_of_birth",
         ...
   ]
}

Editing these fields will return a PermissionDenied error code, for example:

{
 "msg_type": "set_settings",
 "error": {
   "code": "PermissionDenied",
   "message": "Your first name cannot be changed."
 },
 "echo_req": {
   ...
 },
}

The existing 'changeable_fields' in landing_company and landing_company_details API will be replaced by immutable_fields. While old settings will still be available temporarily to allow for backward compatibility, we don't recommend using them. Please keep this in mind when making changes to your codes.

Thank you.
Team Deriv
api-support@deriv.com