Skip to content
Last updated

Document expired

Our system sends the "Document expired" callback when a previously verified applicant's document has expired.

The callback must be enabled in the form's settings in the Dashboard before use.

Schema

typestring
Example:"DOCUMENT_EXPIRED"
document_idstring, = 36 characters

A unique identifier of a document, that is assigned by our system after a document object was created with a “Create a document” request

Example:"27c5caea93ee4656881ef9a30fadd21a3768"
applicant_idstring, = 36 characters

A unique identifier of an applicant, that is assigned by our system after an applicant object was created with a “Create an applicant” request

Example:"27c5caea93ee4656881ef9a30fadd21a3768"
external_applicant_idstring or null, [ 0 .. 50 ] characters

A unique identifier of your user in your system

Example:"8ba166fd-e9ba-49c6-b91a-fdbf0f63f939"
verification_idstring or null, = 36 characters

A unique identifier for a verification, assigned by our system after a verification is created using the “Create a verification" request

Example:"27c5caea93ee4656881ef9a30fadd21a3768"

Example

{
    "type": "DOCUMENT_EXPIRED",
    "document_id": "27c5caea93ee4656881ef9a30fadd21a3768",
    "applicant_id": "27c5caea93ee4656881ef9a30fadd21a3768",
    "external_applicant_id": "8ba166fd-e9ba-49c6-b91a-fdbf0f63f939",
    "verification_id": "27c5caea93ee4656881ef9a30fadd21a3768"
}