Create a Document Liveness

POST https://api.verifik.co/v2/document-liveness

A Document Liveness is the result of all the validations performed on the document passed via a base64 image. We have four types of validations that we perform to the document: Screen Replay, Printed Copy, Portrait Substitution, Digital Manipulation. You can also decide to store the base64 into our CDN so you can retrieve the image that you tested.

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Body

Name	Type	Description
image	blob	The document to test in base64 format.
saveImage	Boolean	This boolean will define if we save the image or not for further inspection.
validateScreenReplay	Boolean	Perform a validation to check if the attack came from a screen replay
validatePrintedCopy	Boolean	Perform a validation to check if the attack came from a printed copy
validatePortraitSubstitution	Boolean	Perform a validation to check if the attack came from a portrait substitution
validateDigitalManipulation	Boolean	Perform a validation to check if the attack came from a digital manipulation
screenReplayCalibration	String	You can adjust the calibration from SOFT, REGULAR or HARD default value is REGULAR.
printedCopyCalibration	String	You can adjust the calibration from SOFT, REGULAR or HARD default value is REGULAR.
portraitSubstitutionCalibration	Strnig	You can adjust the calibration from SOFT, REGULAR or HARD default value is REGULAR.
ignoreDocumentCroppedValidation	Boolean	it will ignore if the document was cropped.
ignoreColourLessValidation	Boolean	it will ignore the lack of color in the document.

Body example

{
    "image": "{{documentoDeAnuar}}",
    "saveImage": true,
    "validatePrintedCopy": true,
    "validateScreenReplay": true,
    "validatePortraitSubstitution": true,
    "validateDigitalManipulation": true
}

Response

200

{
    "data": {
        "client": "613375a1eab2fe08527f81e2",
        "imageSaved": true,
        "imageUrl": "https://cdn.verifik.co/document-liveness/document-liveness-1755887332482",
        "validateScreenReplay": true,
        "validatePrintedCopy": true,
        "validatePortraitSubstitution": true,
        "validateDigitalManipulation": true,
        "sreenReplayScore": 0.4201007,
        "printedCopyScore": 2.7406464,
        "portraitSubstitutionScore": 10.7250834,
        "digitalManipulationScore": -0.124236,
        "screenReplayProbability": 0.0019733,
        "printedCopyProbability": 0.000001,
        "portraitSubstitutionProbability": 0.948844,
        "digitalManipulationProbability": 0.3582724,
        "sreenReplayCalibration": "REGULAR",
        "printedCopyCalibration": "REGULAR",
        "portraitSubstitutionCalibration": "REGULAR",
        "digitalManipulationCalibration": "REGULAR",
        "ignoreDocumentCroppedValidation": false,
        "ignoreColourLessValidation": false,
        "screenReplayWarnings": [
            "GLARE_ON_IMAGE"
        ],
        "printedCopyWarnings": [
            "GLARE_ON_IMAGE"
        ],
        "portraitSubstitutionWarnings": [
            "GLARE_ON_IMAGE"
        ],
        "digitalManipulationWarnings": [
            "GLARE_ON_IMAGE"
        ],
        "screenReplayErrors": [],
        "printedCopyErrors": [],
        "portraitSubstitutionErrors": [],
        "digitalManipulationErrors": [],
        "aggregatedScore": 0.000001,
        "_id": "68a8b6e4d8207d5f3357b630",
        "updatedAt": "2025-08-22T18:28:57.736Z",
        "createdAt": "2025-08-22T18:28:57.736Z",
        "__v": 0,
        "chargesCount": 4
    },
    "signature": {
        "dateTime": "August 22, 2025 6:28 PM",
        "message": "Certified by Verifik.co"
    },
    "id": "A73ZL"
}

409

{
    "message": "At least one validation must be selected. Please enable one of: validateScreenReplay, validatePrintedCopy, validatePortraitSubstitution, or validateDigitalManipulation",
    "code": "MissingParameter"
}