This synchronous API processes and controls official French ID documents:
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 document.
- Metadata: Verifies the metadata of the file to detect document alterations.
Status codes
The API returns the following status codes:
| Code | Code Name | Description |
|---|---|---|
| 1.0 | conform | The document has been fully verified by the AI, it is valid and conform |
| 2.1 | bluriness | The document could not be processed: Bluriness |
| 2.2 | readability | The document could not be processed: Could not read textual information |
| 4.0 | toVerify | We could not process all the controls on the given document, please review its authenticity |
| 5.0 | AIRejected | At least one element on the document is suspected to be fraudulent |
The API extract in real-time relevant information and control information. Control information (depends on the type of identity card):
- Global Status - is the identity card a real valid card: true or false
- Are the initials are present on the photo
- Is the MRZ stripe conform regarding other extracted information
- Is the MRZ stripe valid regarding other extracted information
- Is the photo present
- Are holographic symbols present
User input controls (verify if the expected information matches the extractions):
- first name
- last name
- birth date
- gender
- photo: The photo must be in portrait format and the face must be visible and not covered.
Information extracted cover:
- Card holder's first name
- Card holder's last name
- Card holder's birth date
- Card holder's birth place
- Card holder's address
- Card delivery date
- Card expiry date
- Card Id Number
- Card MRZ
The API accepts images or pdfs. Only one format is accepted at a time. The API accepts the front and back on the same file or on two separate files (either 2 images or 2 pdf pages). A maximum of 2 pages is allowed.
For better results, it is highly recommended to provide documents under these properties:
- The image resolution should be greater than 200 DPI
- The document must not be blurred or rotated
- In case of a photo document, make sure that the text area does not contain any highlights or shadows
- The entire document must be in the frame
Please note the following rate limits are applied :
- Maximum file size: 5 MB.
- Maximum number of calls per minute: 10 calls.
