Retrieve granular check result data

This guide demonstrates how to retrieve granular result data for a check using our API. This is currently supported for the Photo ID check type only. By accessing detailed information via the Retrieve a Check endpoint, you can build more advanced automation or decisioning flows based on specific check outcomes.

Prerequisites

• Amiqus API credentials: Ensure you have valid credentials to authenticate your requests.
• Check type support: This flow currently supports Photo ID checks only. Other check types will not return granular data at this time.
• Valid record ID: You will need a valid record ID associated with a Photo ID check.

Overview of the flow

Below is a sequence diagram illustrating the process:

Step-by-step guide

1. List all steps for a record

Begin by calling the list all steps for a record endpoint, using the record ID you wish to inspect. The response will include an array of step objects. Identify the step with a `type` of `photo_id`, which will contain either the check object or a reference to the check ID.

2. Retrieve the check

Once you have the relevant check ID (either directly from the step object or via its embedded `check`), call the Retrieve a Check endpoint using that ID. Make sure to include the expand=response query parameter to retrieve the detailed result data. This will return a JSON payload with granular result data, such as:

• Document type and issuing country
• Match scores and outcomes
• Expiry dates and extracted fields
• Liveness detection outcomes (if applicable)

This data gives you fine-grained insight into the verification outcome and enables you to make informed decisions programmatically.

What happens next?

After retrieving the check data:

• Log and audit: Store the granular results as needed for audit trails or compliance evidence.
• Automate decisions: Use result fields to update internal systems, trigger workflows, or flag checks for manual review.
• Prepare for future automation: In future releases, we aim to expand support to other check types and enable status automation for clients and records based on check outcomes.

By following this guide, you can make full use of the available granular data for Photo ID checks, enhancing your automation capabilities and improving the transparency of your verification flows.