Liveness Detection [application/json]

Description of the requisition body

Name	Type	Mandatory	Description
fileBase64	String	Yes	Binary content of the file to be processed, encoded as a text string according to the RFC3548 standard using base64 encoding.
fileUrl	String	Yes, when `fileBase64` parameter is not provided	Public URL of the file to be processed.
movements	String	Yes	Movements of the person to be validated. Multiple movements can be specified, including: 'up' for turning the face upwards, 'down' for turning the face downwards, 'left' for turning the face to the left, 'right' for turning the face to the right, 'smile' to validate if the user smiled, and 'blink' to validate if the user blinked with both eyes. This field should be empty in the case of passive life detection.
returnFullFace	Boolean	No	Boolean indicating whether the returned image will be full-sized (true) or reduced-size (false). This parameter will be false if not inserted or assigned false.

Request

Header Params

Authorization

string

required

Token obtained in the Authentication/Authenticate method (JWT). See the route specification for Authenticate (Get JWT)

Example:

Bearer {{bearer_token}}

Body Params application/json

fileBase64

string

required

fileUrl

string

required

movements

array

required

returnFullFace

string

required

Example

{
    "fileBase64" : "",
    "fileUrl":"",
    "movements" : [],
    "returnFullFace" : "true"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200200 Ok Response

application/json

Body

result

object

required

globalScore

integer

required

movementScore

integer

required

livenessScore

integer

required

frontalImage

string

required

requestId

string

required

elapsedMilliseconds

integer

required

status

object

required

code

integer

required

message

string

required

Example

{
    "result": {
        "globalScore": 1.0,
        "movementScore": 1.0,
        "livenessScore": 1.0,
        "frontalImage": "base64"
    },
    "requestId": "xxxxxxxxxxxxxxxxxxxxx",
    "elapsedMilliseconds": 1000,
    "status": {
        "code": 200,
        "message": "Ok"
    }
}

🔴500500 Error Response

Liveness Detection [application/json]

Description of the requisition body#

Request

Request samples

Responses

Description of the requisition body