Skip to main content
POST
/
v2
/
identity
/
identities
/
{identity_id}
/
controls
[
  {
    "id": "ctrl_1234567890abcdef",
    "identity_id": "f190b163-208f-4d73-8deb-4fb8b24add00",
    "type": "DISABLED",
    "controlled_by": "CLIENT",
    "reason_code": "END_USER_REQUESTED",
    "reason": "some client-set reason",
    "created_at": "2024-01-15T10:30:00Z",
    "archived_at": null
  },
  {
    "id": "ctrl_0987654321fedcba",
    "identity_id": "f190b163-208f-4d73-8deb-4fb8b24add00",
    "type": "DISABLED",
    "controlled_by": "PAXOS",
    "reason_code": "OTHER",
    "reason": "some admin-set reason",
    "created_at": "2024-02-20T14:45:00Z",
    "archived_at": null
  },
  {
    "id": "ctrl_abcdef1234567890",
    "identity_id": "f190b163-208f-4d73-8deb-4fb8b24add00",
    "type": "FROZEN",
    "controlled_by": "PAXOS",
    "reason_code": "SANCTIONS",
    "reason": "some admin-set reason",
    "created_at": "2024-03-10T09:15:00Z",
    "archived_at": null
  },
  {
    "id": "ctrl_fedcba0987654321",
    "identity_id": "f190b163-208f-4d73-8deb-4fb8b24add00",
    "type": "DORMANT",
    "controlled_by": "CLIENT",
    "reason_code": "DORMANT",
    "reason": "some reason",
    "created_at": "2024-04-05T16:20:00Z",
    "archived_at": "2024-06-01T10:00:00Z"
  }
]

Path Parameters

​
identity_id
string
required

The Identity ID

Body

application/json
​
type
enum<string>
required
Available options:
DISABLED,
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

Unique identifier for this identity control

​
identity_id
string

The identity ID this control belongs to

​
type
enum<string>
Available options:
DISABLED,
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>

Timestamp when this control was created

​
archived_at
string<date-time>

Timestamp when this control was archived (if applicable)