| Parameters | Description |
|---|---|
| document { | |
| .typeRecognized | Has the document type been recognized? Recognizing the document type is a prerequisite for performing most subsequent controls and extractions. Hence, if this control is KO the response will contain very little information. |
| .vizValid | Is the Visual Inspection Zone (VIZ) text extraction of birth name, first name, last name, and birthdate valid? |
| .mrzValid | Is the OCR-based reading of the MRZ valid? Format and checksums are checked. |
| .notSpecimen | Is the document serial number known as a specimen? |
| .frontSideFound | Has the document's front side been processed? |
| .backSideFound | Has the document's back side been processed? |
| .issuanceAndExpirationDateMatch | Check if the validity duration ( between the issuance date and expiration date, either read from the face, or the MRZ, depending on the document and OCR success) from the document is consistent with the document model. |
| .notExpired | At the requested time, is the document expiration date in the future? This check is not performed for specimen documents. |
| .documentNumberValid | Is the document number valid? Format and checksum are checked. |
| .validityPeriodModelMatch | Are the emission date, expiration date, and theoretical validity duration consistent with the actual document model ( country and model year)? Also, check that the emission date is not in the future. This check is not performed for specimen documents. |
| .allSidesSubmitted | Does the video include a sequence that shows both sides of the document to be checked? (for two-sided documents only, not for PASSPORT). For example, this control is KO when the end user chose the PASSPORT document type before their recording, then showed an identity card: Only the front side of their document has been filmed. |
| .personalNumberValid | Is the personal number valid? Format and checksum are checked. |
| .documentVideoNotTampered | Integrity check and Injection attack detection: indicates whether the document video is authentic (captured from a real camera) or has been manipulated (e.g. by injecting a virtual camera or posting defrauded video via api). The IAD (Injection Attack Detection) part of this control is ignored if the IAD service is not enabled for documents. Available only in case of a video identification (IDSelf only) |
| documet.quality { | |
| .aboveMinimumThreshold | Is image quality above the minimum threshold? |
| document.ocrAnalysis { | |
| .mrzDocumentNumberMatch | Is the document number consistent with the number extracted from MRZ? |
| .mrzFirstNamesMatch | Are the document's first names consistent with the first names extracted from MRZ? |
| .mrzLastNameMatch | Is the document's last name consistent with the previous name in MRZ? |
| .mrzBirthNameMatch | Is the document's birth name consistent with the birth name written in MRZ? |
| .mrzBirthDateMatch | Is the document birthdate consistent with the birthdate extracted from MRZ? |
| .mrzExpirationDateMatch | Is the document expiration date consistent with the expiration date extracted from MRZ? |
| .issuanceDateRead | DEPRECATED - Replaced by vizExtractions.issuanceDateRead |
| .expirationDateRead | DEPRECATED - Replaced by vizExtractions.expirationDateRead |
| document.vizExtractions { | |
| .birthDateRead | Has a birth date been extracted from document VIZ? |
| .issuanceDateRead | Has the issuance date been extracted from document VIZ? |
| .expirationDateRead | Has an expiration date been extracted from document VIZ? |
| .documentNumberRead | Has the document number been extracted from document VIZ? |
| document.documentAspect { | |
| .generalAppearanceMatch | Is the document image consistent with the document type? |
| .picturePresent | Does the document contain a photo of the identity? |
| .originalDocument | Is this an original document (not a printed / photocopy, screen capture…)? This check is performed on the front side page only, or on the first page if no Identity photo has been detected. Available only in case of a video identification (IDSelf only) |
| .pictureNotTampered | The identity photo has not been altered or tampered with. This check is performed only if the Identity photo has been detected. Available only in case of a video identification (IDSelf only) |
| holder.documentConsistency { | |
| .lastNameNotInverted | Are holders' birth/last names in the same order as the document? |
| .namesNotInverted | Are the holder's birth/first names in the same order as the document? |
| .birthNameMatch | Is the holder's first name consistent with document one? |
| .lastNameMatch | Is holder last name consistent with document one? |
| .birthDateMatch | Is holder birth date consistent with document one? |
| .genderMatch | Is holder gender name consistent with document one? |
| .birthPlaceMatch | Is holder birth place consistent with document one? |
| faceMatch { | |
| .idPhotoMatch | Does the end user's selfie match with idPhoto (reference photo extracted from identity document)? In other words, is the end user's selfie the same person as the person of the identity document? |
| .idHolderAgeMatch | Does the end user's age (calculated from the birthdate on the identity document) match with the estimated age range from their appearance in the video? This control is only present if the age verification feature is enabled. It's an additional feature that should be requested and included in the commercial offer. |
| .passiveLiveness | Passive liveness detection: detects if the selfie frame is a live picture, or a presentation attack (mask, photo, screen presentation…) |
Last updated