https://demo-api.incodesmile.com/omni/add/back-id/v2This endpoint is used for storing back side of id for further processing. Image quality check is performed during that call. Number of retries is not limited.
Once process-id is finished, this endpoint cannot be called for retries.
Note: Front-side of id should be uploaded before back side.
In case of passport or only front sided documents, this endpoint should not be called.
Flag stating that this is retry attempt for add/back-id
application/json
Image in base64 format. One of base64Image or imageUrl is required
URL of the image. One of base64Image or imageUrl is required
Response body (application/json)
It's true if the sharpness of the ID meets the requirements.
It's true if the glare of the ID meets the requirements.
Value is based on the resolution of the cropped photo. Low value means after performing the crop we have a bad quality of image. We recommend to retry capture if value is below 155.
Value 0 means it is no shadow on the image and image quality is good, while value 1 represents bad quality of image with a lot of shadow. We recommend to retry capture if value is 1.
If true, server classified image as a front side of an id. If false, server failed to classify image as valid front side of an id or passport and other parameters can be ignored.
If true, server can properly read ID. If false server failed to read some key places of the ID.
UnknownPassportVisaDriversLicenseIdentificationCardPermitCurrencyResidenceDocumentTravelDocumentBirthCertificateVehicleRegistrationOtherWeaponLicenseTribalIdentificationVoterIdentificationMilitaryTaxIdentificationFederalIDMedicalCardIssue year of the ID.
Description of the ID. Could contain country code, state, type of ID, subtype of ID.
Only for Mexican IDs. Flag stating if curp was properly read.
Session Status
AliveClosedDeletedValid ISO alpha-2 or alpha-3 code of the ID issuing country.
Issuing state of the ID.
Classification fail reason
UNKNOWN_DOCUMENT_TYPEWRONG_DOCUMENT_SIDEWRONG_ONE_SIDED_DOCUMENTUNFOLDED_DOCUMENT_PAGE_MISMATCHWRONG_UNFOLDED_DOCUMENTDOCUMENT_NOT_READABLEUNABLE_TO_ALIGN_DOCUMENTID_TYPE_UNACCEPTABLEUNEXPECTED_ERROR_OCCURREDDIGITAL_ID_REQUESTED_BUT_OTHER_PROVIDEDFlag that signals if back id capture should be skipped or not.
Flag that signals if front id capture must be executed after back.
Render mandatory consent page based on this parameter value.
Regulation type for the mandatory consent (only if showMandatoryConsent set to true).
Flag that signals if front side glare should be ignored.
Flag that signals if back side glare should be ignored.
Flag that signals if document is on the edge on the full frame image.
List of accepted documents for that particular country in case of ID_TYPE_UNACCEPTABLE failReason.
UnknownPassportVisaDriversLicenseIdentificationCardPermitCurrencyResidenceDocumentTravelDocumentBirthCertificateVehicleRegistrationOtherWeaponLicenseTribalIdentificationVoterIdentificationMilitaryTaxIdentificationFederalIDMedicalCardFlag that signals if image was redacted as part of the ID capture.
True when biometric face extraction from the front ID was skipped because the client passed extractIdFace=false. While this flag is true, face-match flows that require an ID-side template cannot run; the flag is cleared on a subsequent add/front-id call where extractIdFace is true (or omitted).
Checked only if configured in the session flow.
Maximum number of attempts to capture a photo.
Number of remaining attempts to capture a photo.
ID quality check result based on ML readability estimation. True if perFieldReadability >= 0.38, false otherwise. Only available for Mexican documents when feature is enabled.
Flag indicating if the document side is expired.
Created attempt id.
Response body (application/json)
UTC timestamp in milliseconds
Custom error code or HTTP status code
HTTP status error
Custom error message
Endpoint path
Custom error details