identity_documents_required

Event object returned for identity.documents_required events

This object is returned by the Get Event API when the event type is identity.documents_required.

Object Fields

id · string · required

Unique identifier for this event object

identity_id · string · required

Identifier for the identity requiring documents

required_documents · array · required

List of required document types. Values in this array correspond to the document_type parameter in the Document Upload API.

Example

{
  "id": "d840cf31-352f-4190-a476-7522bf3eafda",
  "identity_id": "4fd025ab-f29f-47e6-a02e-df90a61c7ec9",
  "required_documents": ["PROOF_OF_ADDRESS", "PROOF_OF_FUNDS"]
}