Request an identity document verification
On this page, you will learn how to initiate a new identity document verification using the API.
To initiate a new identity document verification, send the file containing the ID document using the following endpoint:
POST /id_document_verifications
curl --location --request POST '{baseUrl}/id_document_verifications' \
--header 'Authorization: Bearer {apiKey}' \
--form 'first_name="John"' \
--form 'last_name="Doe"' \
--form 'file=@"/path/to/the/document/id_document.jpeg"'
{
"id": "14bf533c-964f-4927-8267-b577d2776321"
}
Query Param | Type | Description |
---|---|---|
file | file | The file containing the image of the ID document (ID cards, passports, residence permits, driving licenses). This file may include both the front (recto) and back (verso) of the document. If it contains only one side, you should provide the other side in the additional_file parameter.Accepted formats: PNG, JPEG, JPG, PDF. Max size: 10 MB. Max resolution: 20 mpx. |
additional_file | file | [optional] The optional file containing the opposite side of the ID document. This is required only if the file parameter contains only one side of the ID document.Accepted formats: PNG, JPEG, JPG, PDF. Max size: 10 MB. Max resolution: 20 mpx. |
document_type | string | [optional] Defines the type of ID document you want to verify. You can use this parameter to restrict the initial list of supported document types (ID cards, passports, residence permits, driving licenses, old Italian ID cards). |
first_name | string | The first name of the ID document holder. The first name provided must match exactly as it appears on the document, as a consistency check will be performed. If multiple given names are listed on the document, you must provide only the first one. |
last_name | string | The last name of the ID document holder. The last name provided must match exactly as it appears on the document, as a consistency check will be performed. If both a birth name and a usage name are listed on the document, you must provide the birth name. |
In the response, you'll find the id
. This value is required to retrieve the verification results.
Updated 2 days ago