post https://api.datakeen.co/api/v1/reco/construction-professional-card
Summary
This synchronous API extracts in real-time information from French construction professional card document.
- firstName: Holder’s first name
- lastName: Holder’s last name
- cibtpURL: CIBTP API's URL to call to get card's validity
- type: The type of the card. It can be either
carte BTPorattestation provisoire carte BTP
Additional parameters
The API uses option to control the behavior of the error codes:
standard(default): Stops processing on quality error codes2.Xand returns the relevant error code.remediation: Ignores error codes and processes the entire file, always returns code 1.0.
An option can be provided in the paramDict.
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.11 | qrCodeUnreadable | The QR code could not be read from the document |
| 2.6 | unexpectedDocumentType | The document is not of the expected type |
| 2.7 | multiplePagesDetected | Multiple pages detected, only one was expected |
| 8.0 | specimen | The document is a specimen |
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 bluriness 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.