Appearance
Automated Document Verification
Endpoints for requesting automated document verifications on cases.
TIP
We'll refer to this service as "ADV" throughout this page.
Start session
Sessions are required for cases to complete a doc verification. Sessions are sent out automatically via the email address of the case.
| Endpoint | /api/cases/{caseId}/automateddocverification |
|---|---|
| Method | POST |
Request
The request contains configuration options for the session.
| Property | Required | Notes |
|---|---|---|
| Liveness | ✅ | Specifies what level of liveness check is required. Options are Active or Passive |
json
{
"liveness":"passive"
}Response
Expect a 200 status code with an empty body.
Portal Interface
The below sections outline Automated Document Verification as displayed on the Portal.
Requesting a Session
WARNING
An Automated Document Verification Session can only be required if:
- The ADV service is enabled on your client.
- The case has an email address.
- The case does not have an existing pending, active, or successful ADV session.
Click the
Requestbutton on the ADV status card. This is present on the main Case sidebar, or on the "Checks" page.Case details tab
Case checks tab
Select between the liveness check options, and confirm the submission.
Click submit. The user will receive an email with a link and QR code. An example of this is below:
Session Progress
The Status Card will change as the state of the session changes. The below table describe the various potential statuses:
| Image | Description |
|---|---|
 | No ADV session exists for this case. ADV is available, click Request to begin. |
 | The case has no email associated, no an ADV session cannot be created. |
 | A session has been requested, but has not yet been emailed to the user. |
 | A session is in-progress. You can view and/or copy the session URL using the controls in the card. |
 | Verification was successful. |
 | Verification failed, or the ADV session itself encountered an error. A new session can be requested to try again. |
Session Results
Case Checks
Once the session is complete, the results will be available on the "Checks" tab, under "Automated Document Verification". Or via cases/{caseId}/checks/{checkId} in the API.
TIP
If you have the "Show Categories" toggle enabled, ADV appears under the "ID Verification" category.
ADV Operation Entries
TIP
If you have the "Show Categories" toggle enabled, ADV operations will be listed under "ID Verification" alongside other ID-related operations.
ADV Results
The results page displays any Risks that were raised and allows the user to remediate them. A detailed breakdown of the ADV results is also displayed for reference.
The images used for the check are also displayed. Note that due to the nature of the checks, not all images are displayed.
API Results
Request options
| Endpoint | /api/cases/{caseId}/checks/{checkId} |
|---|---|
| Method | GET |
Response
Here is an example of a response for the ADV Response:
In this example check the user presented an out of date document (passport) and was there for the liveness check but the face didn't match the document.
You can request each image generated from the livness check using the supplied urls in images with a GET request.
(Check the Swagger definition for the full schema: https://api-sandbox.eyedp.com/swagger)
json
{
"id": 2288,
"checkName": "automated-doc-verification",
"checkLabel": "Automated Document Verification",
"checkDescription": "Automatic verification of Government issued Proof of Identity Documents.",
"createTs": "2025-12-03T15:41:00.567",
"advResponse": {
"advCheckResult": [
{
"type": "ID_DOCUMENT_AUTHENTICITY",
"state": "DONE",
"report": {
"recommendation": {
"value": "REJECT"
},
"breakdown": [
{
"subCheck": "document_in_date",
"result": "FAIL",
"details": []
}
]
},
"created": "2025-12-03T15:40:52Z",
"lastUpdated": "2025-12-03T15:40:59Z"
},
{
"type": "LIVENESS",
"state": "DONE",
"report": {
"recommendation": {
"value": "REJECT"
},
"breakdown": [
{
"subCheck": "liveness_auth",
"result": "FAIL",
"details": []
}
]
},
"created": "2025-12-03T15:40:23Z",
"lastUpdated": "2025-12-03T15:40:23Z"
},
{
"type": "LIVENESS",
"state": "DONE",
"report": {
"recommendation": {
"value": "APPROVE"
},
"breakdown": [
{
"subCheck": "liveness_auth",
"result": "PASS",
"details": []
}
]
},
"created": "2025-12-03T15:40:52Z",
"lastUpdated": "2025-12-03T15:40:52Z"
},
{
"type": "ID_DOCUMENT_FACE_MATCH",
"state": "DONE",
"report": {
"recommendation": {
"value": "REJECT"
},
"breakdown": [
{
"subCheck": "ai_face_match",
"result": "FAIL",
"details": [
{
"name": "confidence_score",
"value": "0.81"
}
]
}
]
},
"created": "2025-12-03T15:40:52Z",
"lastUpdated": "2025-12-03T15:40:59Z"
}
],
"images": [
{
"url": "https://api-sandbox.eyedp.com/api/cases/814/assets/3957",
"contentType": "image/jpeg"
},
{
"url": "https://api-sandbox.eyedp.com/api/cases/814/assets/3960",
"contentType": "image/jpeg"
},
{
"url": "https://api-sandbox.eyedp.com/api/cases/814/assets/3962",
"contentType": "image/jpeg"
}
]
}
}