Appearance

Automated document verification ​

This guide shows how to run Automated Document Verification (ADV) through the EyeDP API. ADV emails the applicant a session link. They capture a government-issued identity document and complete a liveness check. Results then appear as a case check.

When the check finishes, EyeDP sends an automated-doc-verification/completed webhook. Use the checkId from that payload to fetch the result.

Case requirements ​

The case must already satisfy these before you start a session:

PropertyNotes
TypePerson (Individual). Entity cases are not supported.
GivenNames and SurnameBoth are required. ADV does not support Fullname.
DOBDay, DOBMonth, DOBYearFull date of birth is required.
EmailAddressesThe session link is emailed to the case.

ADV must also be enabled on your client, and the case must not already have a pending, active, or successful ADV session.

Steps ​

  1. Authenticate with client credentials. See API basics.

  2. Create a case that meets the case requirements above. Use GivenNames and Surname, not Fullname, and include a full date of birth and at least one email address.

  3. Start an ADV session with POST /api/cases/{caseId}/automateddocverification. Send liveness as none, active, or passive. A 204 No Content response means the session has been created and the email will be sent.

  4. The applicant opens the emailed link (or QR code) and completes document capture and liveness. While the session is in progress you can copy the session URL from the Portal status card if you need to share it again.

  5. Wait for the check to finish. Register a webhook for automated-doc-verification/completed and use the checkId from the payload. If you are not using webhooks, poll Get case checks until a check with checkName automated-doc-verification appears.

  6. Fetch the result with GET /api/cases/{caseId}/checks/{checkId}. The advResponse includes authenticity, liveness, and face-match reports, plus image URLs. See API results for the response shape.

If the session fails, request a new session on the same case and repeat from step 3.