Summary
This synchronous API extracts information and verifies ID documents:
- French national ID Cards (2003 or 2021 card)
- French biometric Passports
- French living Permits (2011 or 2021 card)
- French driver License (2013 card)
- Foreign ID Cards: biometric passport, national ID card and living permit (TD1 and TD3 formats only).
Control categories
The control categories returned by the API are the following:
- Data coherency: Verifies the format and the content of the extracted information.
- Visual controls: Verifies the visual conformity of the card.
- Metadata: Verifies the metadata of the file to detect document alterations.
User input matching
Optional user input can be provided to match with extracted information:
- first name.
- last name.
- birth date.
- gender.
- photo (must be in portrait format with the face clearly visible and uncovered).
If provided, the API will also return a control category named userInput.
The API returns error codes to indicate the status of the document extraction and verification (for additional information on the error codes, please refer to the Error codes section).
The API uses option to control the behavior of the error codes:
standard: Stops processing on quality error codes2.Xand returns the relevant error code.remediation: Ignores error codes and processes the entire file, always returns error code 1.0.
Additional parameters
returnConfidence(TrueorFalse(default)): Specifies whether to return confidence values (between 0 and 1) for each extraction and control.returnReport(TrueorFalse(default)): Specifies whether to return a PDF report of the analysis (base64-encoded in the report key).- Beta
multiId(TrueorFalse(default)): Specifies whether to extract multiple ID cards. This feature is currently in beta, and further testing is ongoing to ensure stability and accuracy.
Error codes
The API returns the following error codes:
| Code | Code Name | Description |
|---|---|---|
| 1.0 | conform | The document has been fully verified by the AI, it is valid and conform |
| 2.2 | readability | The document could not be processed: Could not read textual information |
| 2.4 | missingMRZ | The document could not be processed: The MRZ could not be found |
| 2.5 | missingPart | The document could not be processed: One side of the document is missing |
| 2.6 | noIdFound | The document could not be processed: Could not find any ID |
| 3.0 | expired | The document has expired |
| 4.0 | toVerify | We could not process all the controls on the given document, please review its authenticity |
| 5.0 | fraudulent | At least one element on the document is suspected to be fraudulent |
| 7.0 | owner | The owner of the document does not match the user input |
| 8.0 | specimen | The document has been found in our specimen database |
File requirements
The API accepts images or PDFs. Only one format is accepted at a time.
The following configurations are supported:
- Front and back in the same page.
- Front and back in the same file.
- Front and back on two separate files (either 2 images or 2 pdf pages).
Document recommendations
For better results, it is highly recommended to provide documents under these properties:
- Image resolution > 300 DPI for information extraction.
- Image resolution > 600 DPI for verification.
- No blurriness or rotation in the document.
- Text area free of highlights or shadows.
- The document is fully visible and whithin the frame.
Rate limits
Please note the following rate limits are applied :
- Maximum file size: 5 MB.
- Maximum number of calls per minute: 10 calls.
Upcoming updates
- multiId stability: The multiId feature will be enhanced and stabilized for broader usage.
- New error codes: Codes 2.1 (blurriness), 2.3 (reflections) will be added to provide more detailed error reporting.
Document example
