identity_documents_required

{ "id": "d840cf31-352f-4190-a476-7522bf3eafda", "identity_id": "4fd025ab-f29f-47e6-a02e-df90a61c7ec9", "documents": [ { "document_type": "IDENTITY_VERIFICATION", "required": true, "explanation": "Required to verify your identity." }, { "document_type": "PROOF_OF_RESIDENCY", "required": true, "explanation": "Required to confirm your current residential address." }, { "document_type": "PROOF_OF_FUNDS", "required": false, "explanation": "Optional; provide to raise your transfer limits." } ], "required_documents": ["IDENTITY_VERIFICATION", "PROOF_OF_RESIDENCY"] }

Object Fields

string

required

Unique identifier for this event object

string

required

Identifier for the identity requiring documents

array

required

The full set of documents requested for this EDD — both required and optional. Use this field to present the document checklist to your end user.

Show documents entry

string

required

The document type (e.g., IDENTITY_VERIFICATION). Corresponds to an entry in the document_types parameter of the Document Upload API.

boolean

required

Whether the document is mandatory. Optional documents may be requested to provide additional context but do not block EDD completion.

string

required

Human-readable context explaining why the document is requested. Empty ("") when no explanation is provided.

array

deprecated

Flat list of required document type strings, in the order they appear in documents. Deprecated — use documents instead, which also covers optional documents and includes per-document metadata. This field lists required documents only.

This event tells you which documents are requested; it does not carry upload status. To check the current upload state of each document (NOT_STARTED, PENDING_UPLOAD, REJECTED_UPLOAD, COMPLETED_UPLOAD), call List Identity Documents. A List entry’s status may itself be absent when its upload state cannot be determined — treat a missing status as an unresolved requirement, not as a contract violation.

{
  "id": "d840cf31-352f-4190-a476-7522bf3eafda",
  "identity_id": "4fd025ab-f29f-47e6-a02e-df90a61c7ec9",
  "documents": [
    {
      "document_type": "IDENTITY_VERIFICATION",
      "required": true,
      "explanation": "Required to verify your identity."
    },
    {
      "document_type": "PROOF_OF_RESIDENCY",
      "required": true,
      "explanation": "Required to confirm your current residential address."
    },
    {
      "document_type": "PROOF_OF_FUNDS",
      "required": false,
      "explanation": "Optional; provide to raise your transfer limits."
    }
  ],
  "required_documents": ["IDENTITY_VERIFICATION", "PROOF_OF_RESIDENCY"]
}

API Documentation

Deposits and Withdrawals

Address Verification

Identity

Profiles

Sandbox

Orchestrations / Conversions

Taxes

Trading

Rewards Engine

Events

API Credentials

User Audit Logs

Websockets

Webhooks

Problems

Object Fields

​Object Fields

Object Fields