DocumentationAPI Reference
Help CenterAPI ChangelogOpenAPI SpecStatus
Documentation

How verifications work

Verifications move through various statuses as they progress from initialization to data submission and finally verification completion. Verifications are independent objects that are associated with an Organization. In order to configure collection options and requirement status verification checks, a VerificationTemplate is needed. A Verification can be created either through our hosted/embedded flows or through an external API.

Verification lifecycle

The basic flow of a verification looks like this:

  1. A new Verification is initialized with the status initiated with configuration from a VerificationTemplate
  2. Attributes and images are attached to the verification
  3. A verification is submitted with the status of submitted and attributes and images are no longer able to be changed.
  4. Persona will process the submitted data and generate checks and decision status based on the configuration from the VerificationTemplate
  5. If verification passes, the verification status is updated to passed
  6. If verification fails, the verification status is updated to failed
  7. If verification requires a reattempt, the verification status is updated to requires_retry

Verification statuses

StatusDescription
createdVerification has started, claimed information can now sent and saved to the server for verification
confirmedVerification has been confirmed. This is a status specific to PhoneNumber verifications where they have verified a confirmation code that was entered.
submittedVerification has been submitted, the claimed information is frozen and the server will process the verification
passedVerification has passed. The required checks have passed and the information is verified
failedVerification has failed. Some or all of the required checks have failed and verification has failed
requires_retryVerification requires a resubmission. The checks could not be fully processed due to issues with the submitted information
cancelledVerification timed out. This is usually indicative of an internal server error