Skip to main content
WEBHOOK
identity.control.created
{
  "id": "bd019f1c-89a7-4372-9d21-eaad9280dc41",
  "type": "identity.control.created",
  "source": "com.paxos",
  "time": "2025-01-07T14:30:02Z",
  "object": "event",
  "is_test": false
}

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.

Triggered when a control is applied to an identity (for example, SELL_ONLY, CLOSED, FROZEN, or DORMANT).
Webhook payloads contain only event metadata. Use the Get Event API with the event ID to retrieve full details.

​
Event Object Structure

The Get Event API returns an identity_control object with control details.

Body

application/json

Webhook payload containing event metadata. Use the event ID with the Get Event API to retrieve full details.

The webhook payload structure sent to your endpoint

​
id
string<uuid>
required

The event identifier used to query the Events API for full details

​
type
enum<string>
required

The type of event that occurred

Available options:
identity.documents_required,
identity.approved,
identity.denied,
identity.disabled,
identity.kyc_refresh.started,
identity.kyc_refresh.completed,
identity.kyc_refresh.expired,
identity.control.created,
identity.control.deleted,
orchestration.processing,
orchestration.completed,
orchestration.failed,
transfer.crypto_deposit.pending,
transfer.crypto_deposit.completed,
transfer.crypto_deposit.failed,
transfer.crypto_withdrawal.pending,
transfer.crypto_withdrawal.completed,
transfer.crypto_withdrawal.failed,
transfer.act_deposit.pending,
transfer.act_deposit.completed,
transfer.act_deposit.failed,
transfer.act_withdrawal.pending,
transfer.act_withdrawal.completed,
transfer.act_withdrawal.failed
​
source
enum<string>
required

Always 'com.paxos'

Available options:
com.paxos
​
time
string<date-time>
required

When the event occurred, RFC3339 format

​
object
enum<string>
required

Always 'event'

Available options:
event
​
is_test
boolean

Whether the event was a test event. Test events are only sent via the Test feature in Dashboard.

Response

200

Webhook successfully received