Skip to main content
DELETE
/
v2
/
identity
/
identities
/
{identity_id}
/
controls
[
  {
    "control": "DISABLED",
    "set_by": "CLIENT",
    "reason_code": "END_USER_REQUESTED",
    "reason": "some client-set reason"
  },
  {
    "control": "DISABLED",
    "set_by": "PAXOS",
    "reason_code": "OTHER",
    "reason": "some admin-set reason"
  },
  {
    "control": "FROZEN",
    "set_by": "PAXOS",
    "reason_code": "SANCTIONS",
    "reason": "some admin-set reason"
  },
  {
    "control": "DORMANT",
    "set_by": "CLIENT",
    "reason_code": "DORMANT",
    "reason": "some reason"
  }
]

Path Parameters

​
identity_id
string
required

The Identity ID

Body

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

Freetext reason for setting or clearing the control

Response

A successful response.

​
control
enum<string>
Available options:
DISABLED,
FROZEN,
DORMANT
​
set_by
enum<string>
Available options:
PAXOS,
CLIENT
​
reason_code
enum<string>
Available options:
OTHER,
DORMANT,
END_USER_REQUESTED,
SANCTIONS
​
reason
string

Reason why this identity control was set