Skip to main content
WEBHOOK
identity.documents_required
{
  "id": "bd019f1c-89a7-4372-9d21-eaad9280dc41",
  "type": "identity.documents_required",
  "source": "com.paxos",
  "time": "2025-01-07T14:30:02Z",
  "object": "event"
}
Triggered when additional documents are required for identity verification.
Webhook payloads contain only event metadata. Use the Get Event API with the event ID to retrieve full details including required documents.

​
Event Object Structure

The Get Event API returns an identity_documents_required object with details about the required documents.

Body

application/json
​
id
string<uuid>
required
​
type
enum<string>
required
Available options:
identity.documents_required,
identity.approved,
identity.denied,
identity.disabled,
identity.kyc_refresh.started,
identity.kyc_refresh.completed,
identity.kyc_refresh.expired,
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
Available options:
com.paxos
​
time
string<date-time>
required
​
object
enum<string>
required
Available options:
event

Response

200