Skip to main content
DELETE
/
v2
/
identity
/
identities
/
{identity_id}
/
controls
[
  {
    "control": "CLIENT_DISABLED",
    "reason_code": "END_USER_REQUESTED",
    "reason": "some client-set reason"
  },
  {
    "control": "ADMIN_DISABLED",
    "reason_code": "OTHER",
    "reason": "some admin-set reason"
  },
  {
    "control": "ADMIN_FROZEN",
    "reason_code": "SANCTIONS",
    "reason": "some admin-set reason"
  },
  {
    "control": "DORMANT",
    "reason_code": "DORMANT",
    "reason": "some reason"
  }
]

Path Parameters

​
identity_id
string
required

The Identity ID

Body

application/json
​
control
enum<string>
required
Available options:
CLIENT_DISABLED,
DORMANT
​
reason
string

Freetext reason for setting or clearing the control

Response

A successful response.

​
control
enum<string>
Available options:
CLIENT_DISABLED,
ADMIN_DISABLED,
ADMIN_FROZEN,
DORMANT
​
reason_code
enum<string>
Available options:
OTHER,
DORMANT,
END_USER_REQUESTED,
SANCTIONS
​
reason
string

Reason why this identity control was set