Skip to main content
POST
/
v2
/
identity
/
identities
/
{identity_id}
/
controls
[
  {
    "id": "59b8e3c5-2b6e-4fa6-afcf-8c685598241d",
    "type": "CLOSED",
    "controlled_by": "CLIENT",
    "reason_code": "END_USER_REQUESTED",
    "reason": "some client-set reason",
    "created_at": "2006-01-02T15:04:05Z"
  },
  {
    "id": "5f1eb60c-b292-482c-96fe-9e3e265abcd4",
    "type": "CLOSED",
    "controlled_by": "PAXOS",
    "reason_code": "OTHER",
    "reason": "some admin-set reason",
    "created_at": "2006-01-02T15:04:05Z"
  },
  {
    "id": "173fdece-0792-4833-a6bb-232b461a9fa4",
    "type": "FROZEN",
    "controlled_by": "PAXOS",
    "reason_code": "SANCTIONS",
    "reason": "some admin-set reason",
    "created_at": "2006-01-02T15:04:05Z"
  },
  {
    "id": "ae54b3b4-cce6-4707-b34b-c9c4f0537798",
    "type": "DORMANT",
    "controlled_by": "CLIENT",
    "reason_code": "DORMANT",
    "reason": "some reason",
    "created_at": "2006-01-02T15:04:05Z"
  }
]

Path Parameters

​
identity_id
string
required

The Identity ID

Body

application/json
​
type
enum<string>
required
Available options:
CLOSED,
DORMANT
​
reason_code
enum<string>
required
Available options:
OTHER,
DORMANT,
END_USER_REQUESTED,
SANCTIONS
​
reason
string

Freetext reason for setting or clearing the control

Response

A successful response.

​
id
string
​
type
enum<string>
Available options:
CLOSED,
FROZEN,
DORMANT
​
controlled_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

​
created_at
string<date-time>

Time this identity control was created