Skip to content

Developer Documentation

Authenticity Checks processing parameters description - Regula

Authenticity Checks

The Document Reader SDK provides numerous checks, representing the advanced security techniques to verify the document's authenticity and prevent its counterfeiting. See the overview table for details.

Authenticity check	Processing parameter	Default value
Image patterns	`checkImagePatterns`	`true`
Liveness	`checkLiveness`	`true`
Barcode format	`checkBarcodeFormat`	`true`
Portrait comparison	`checkPhotoComparison`	`true`
Photo embedding type	`checkPhotoEmbedding`	`true`
Security Text	`checkSecurityText`	`true`
IPI text	`checkIPI`	`true`
UV luminescence	`checkUVLuminiscence`	`true`
Protection fibers	`checkFibers`	`true`
IR visibility	`checkIRVisibility`	`true`
B900 IR	`checkIRB900`	`true`
Extended MRZ	`checkExtMRZ`	`true`
Extended OCR	`checkExtOCR`	`true`
Axial	`checkAxial`	`true`
LetterScreen	`checkLetterScreen`	`false`

Liveness Checks

The "Liveness" validation comprises the set of checks to ensure the identity document is physically presented. See the table for all available liveness checks.

Liveness check	Processing parameter	Default value
Electronic device	`checkED`	`true`
Black and White Copy	`checkBlackAndWhiteCopy`	`true`
Hologram detection	`checkHolo`	`true`
OVI	`checkOVI`	`true`
MLI	`checkMLI`	`true`
Dynaprint	`checkDynaprint`	`true`
Geometry	`checkGeometry`	`true`

Enable or Disable Checks

Most authenticity checks are enabled by default. To enable or disable concrete authenticity checks, use their corresponding parameters with necessary values (true or false). For details, explore the Overview section. See the example below.

{
    "processParam": {
        "authParams": {
            "checkLiveness": false,
            "livenessParams": {
                "checkHolo": false,
                "checkED": false,
                "checkOVI": false,
                "checkMLI": false,
                "checkBlackAndWhiteCopy": false,
                "checkDynaprint": false,
                "checkGeometry": false
            },
            "checkImagePatterns": false,
            "checkPhotoEmbedding": false,
            "checkBarcodeFormat": false,
            "checkPhotoComparison": false,
            "checkSecurityText": false,
            "checkUVLuminiscence": false,
            "checkFibers": false,
            "checkExtMRZ": false,
            "checkExtOCR": false,
            "checkIRB900": false,
            "checkIRVisibility": false,
            "checkIPI": false,
            "checkAxial": false,
            "checkLetterScreen": true
        }
    }
}

By default, if the specific check is enabled but not performed due to some limitation, it's marked as WasNotDone. This applies only to the Photo Embedding Type and Liveness checks—if they are marked as WasNotDone, the overall security checks' status also shows up as not performed.

To override this behavior, use the strictSecurityChecks parameter. When enabled, this parameter marks security checks that don’t meet minimum requirements as Failed (instead of WasNotDone), which causes the overall security status to be failed.

{
    "processParam": {
        "strictSecurityChecks": true
    }
}

Next Steps