Liveness Detection [multipart/form-data]

Request

Header Params

Authorization

string

required

Authorization token obtained in the Authentication/Authenticate method

Example:

Bearer {{bearer_token}}

Body Params multipart/form-data

file

required

Binary of the file to be processed.

fileUrl

string

required

Public URL of the file to be processed

movement

string

required

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. A 415 error will be returned if image detection is performed and this field is not empty.

returnFullFace

string

required

Boolean indicating whether the returned image will be full-sized (true) or reduced-sized (false). This parameter will be false if not inserted or assigned false.

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://mostqiapi.com/liveness/detect' \
--header 'Authorization: Bearer ' \
--form 'file=@""' \
--form 'fileUrl=""' \
--form 'movement=""' \
--form 'returnFullFace=""'

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