Last updated

Verification status changed

Our system sends the “Verification status changed” callback when a user completes and submits a form. Please note that this callback is sent with the verification_status parameter set to pending.

Enable in the Dashboard first

The callback must be enabled in the Dashboard for a specific form before use. For instructions, see Using the “Verification status changed” callback.

Schema

typestring
Example: "VERIFICATION_STATUS_CHANGED"
applicant_idstring(uuid)= 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: "723f46ab04feb64f442946f2953a67eaecf7"
verification_statusstring

Verification status, that indicates the current state of a verification process

  • unused: a user has not completed the form
  • pending: the verification is in progress
  • completed: the verification has been successfully completed
Example: "pending"
external_applicant_idstring or null[ 0 .. 50 ] characters

A unique identifier of your user in your system

Example: "cb1eebbe-9945-4e64-8f60-c920f1e3e237"
form_idstring or null(uuid)= 36 characters

A unique identifier of a form, assigned by our system after it is created in the Dashboard

Example: "d87132ba092d8148ba1891736832d0451ac2"
form_tokenstring(uuid)= 36 characters

A unique token for a form, generated by our system, and included as part of a form URL

Example: "7505262b02bb0145c62a04d969eacedb4873"
verification_idstring or null(uuid)= 36 characters

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

Example: "d2177cdf067d424a221b5d045dc616bf81f9"
verification_attempts_leftinteger or null(number)

A number of verification attempts available for a user, set in form settings in the Dashboard. A null value means “not limited”. It equals 0 if set in the settings

Example: 5
request_idstring(uuid)= 36 characters

A unique identifier for a callback request, assigned by our system after a callback is automatically created by our system after an event occurs

Example: "5eb27e030be7f24a7f19c794926f1d2f2abc"

Example

{
  "type": "VERIFICATION_STATUS_CHANGED",
  "verification_status": "pending",
  "applicant_id": "aa6ca3a10440624d671b9ef4771c32cb9d3a",
  "external_applicant_id": "",
  "form_id": "24148eb10810e24b2c1afaa4b9759008d352",
  "form_token": "d2177cdf067d424a221b5d045dc616bf81f9",
  "verification_id": "270128a807f3c24bfb1b8da4a4af7d2080c4",
  "verification_attempts_left": null,
  "request_id": "5eb27e030be7f24a7f19c794926f1d2f2abc"
}
Previous page
Next page