Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.paxos.com/llms.txt

Use this file to discover all available pages before exploring further.

This object is returned by the Get Event API when the event type is identity.control.created or identity.control.deleted.

​
Object Fields

​
id
string
required
Unique identifier for this event object
​
identity_id
string
required
Identifier for the affected identity
​
control_id
string
required
Identifier for the control that was created or deleted
​
control_type
string
required
The type of control applied to the identityAvailable options: SELL_ONLY, CLOSED, FROZEN, DORMANT
​
set_by
string
required
Indicates who set the controlAvailable options: PAXOS, CLIENT
​
is_overridable
boolean
required
Whether the control can be overridden by a client
​
reason_code
string
required
The reason the control was createdAvailable options: OTHER, END_USER_REQUEST, INACTIVITY, COMPLIANCE_KYC, COMPLIANCE_EDD, COMPLIANCE_SCREENING, COMPLIANCE_INVESTIGATION, COMPLIANCE_INCOMPLETE, RISK_FRAUD, LEGAL_ORDER, ADMINISTRATIVE
{
  "id": "d840cf31-352f-4190-a476-7522bf3eafda",
  "identity_id": "4fd025ab-f29f-47e6-a02e-df90a61c7ec9",
  "control_id": "87654321-5555-4444-3333-210987654321",
  "control_type": "DORMANT",
  "set_by": "PAXOS",
  "is_overridable": false,
  "reason_code": "INACTIVITY"
}