What is required for a Identity Document Check?

Are you using the dashboard?

If you would like to start processing an Identity Document Check, you can start a check using your dashboard by just clicking the “New check” button on your dashboard and follow the instructions. If you want the applicant to fill out a form and provide the necessary documents, you will need the applicant's name and email address.

Processing an Identity Document Check via API 

You can create a check (either Express or Standard) via the API.

Express check example curl command:

$ curl -X POST https://api.eu.onfido.com/v3.3/checks \
-H 'Authorization: Token token=<YOUR_API_TOKEN>' \
-H 'Content-Type: application/json' \
-d '{
"applicant_id": "<APPLICANT_ID>",
"report_names": ["document"]
}

Standard check example curl command:

$ curl -X POST https://api.eu.onfido.com/v3.3/checks \
-H 'Authorization: Token token=<YOUR_API_TOKEN>' \
-H 'Content-Type: application/json' \
-d '{
"applicant_id": "<APPLICANT_ID>",
"applicant_provides_data": "true",
"report_names": ["document"]

When creating an applicant for a Standard Check, please include the applicant's email address so that they can receive an email asking them to provide the necessary data.

Are you integrating with our API?

If you are integrating with our API, you can call an Identity Document Check on a user. The user will be asked to upload an identity document on your chosen platform. To reduce failed results, we require:

• Colour image
• Clear image
• Image with no glare
• Full image of ID document

To increase the completion rates, we only allow users to submit supported documents. When submitting their identity document, users on the Android and iOS SDKs are prompted to choose from a list of supported documents according to their country.

User drop-out can be reduced with the glare detection feature. Strong light shining on an identity document causes glare which may obscure essential information. This may make the document difficult to verify. The glare detection feature, available on the iOS SDK and Android SDK, notifies users that their photo contains glare as soon as they take it. The user is then instantly prompted to take another photo.