Liveness Detection [application/json]

POST

https://mostqiapi.com/liveness/detect

livenessprova de vidabiometria facial

Last modified:2024-11-28 14:21:48

Request

Header Params

Authorization

string

required

Token de autorização obtido no método Authentication/Authenticate JWT. Ver especificação da rota Authenticate (Get JWT)

Example:

Bearer {{bearer_token}}

Body Params application/json

fileBase64

string <base64>

optional

🔸Requerido quando o parâmetro fileUrl não é informado. Binário do arquivo a ser processado, codificado em string de texto conforme o padrão RFC 4648, usando a codificação base64.

fileUrl

string

optional

🔸Requerido quando o parâmetro file não é informado. Url pública do arquivo a ser processado.

movements

array[string]

optional

Movimentos da pessoa a serem validados. Pode-se especificar mais de um, sendo: "up" virar rosto para cima, "down" virar rosto para baixo, "left" virar rosto para esquerda, "right" virar rosto para direita, "smile" sorrir, "blink" piscar com os dois olhos.

returnFullFace

boolean

optional

Booleano indicando se a imagem retornada será fullSize (true) ou imagem com tamanho reduzido (false).
Esse parâmetro será falso se não for inserido ou se atribuído false.

Default:

false

Example

{
  "fileBase64": "",
  "fileUrl": "",
  "movements": [
    "up",
    "left",
    "down",
    "right",
    "smile"
  ],
  "returnFullFace": "true"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://mostqiapi.com/liveness/detect' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "fileBase64" : "",
    "fileUrl":"",
    "movements" : [
        "up",
        "left",
        "down",
        "right",
        "smile"
    ],
    "returnFullFace" : "true"
}'

Responses

⚪0S100 Success

application/json

Body

result

object

required

Lista contendo o resultado do método.

globalScore

number <float>

required

Ponto flutuante contendo o score que representa a avaliação global do Liveness, agregando informações dos movimentos feitos pelo usuário (incluindo penalidades para movimentos não requisitados) e também sobre a veracidade da prova de vida realizada. Seu valor vai de 0 a 1 e, caso o usuário tenha realizado todos os movimentos requisitados pelo Liveness e seja uma pessoa viva, assumirá valores acima de 0.5, caso contrário, apresentará valores abaixo deste limiar.

movementScore

number <float>

required

Ponto flutuante contendo o score que representa o total de movimentos encontrados temporalmente pelo Liveness com relação ao que foi requisitado para o usuário, considerando a ordem e incluindo penalidades para movimentos não requisitados.

livenessScore

number <float>

required

Ponto flutuante contendo o score que representa a avaliação do Liveness no que diz respeito à veracidade da prova de vida realizada pelo usuário. Seu valor vai de 0 a 1 e, em casos de detecção de fraude, será retornado o valor menor que 0.5.

imageScore

number <float>

required

Ponto flutuante contendo o score que representa a qualidade da frontalImage retornada. Seu valor varia de 0 a 1 e quanto mais próximo de 1, mais adequada a imagem é para um possível cadastro. É considerado que uma imagem ótima para cadastro possui a face frontal e centralizada, os olhos abertos e uma boa qualidade geral da imagem, incluindo boa iluminação, contraste, entre outros. Caso não seja retornado uma frontalImage, o imageScore retornado será 0. Recomenda-se considerar que uma imagem adequada para cadastro possui imageScore acima de 0.7, porém esse valor pode ser modificado para atender melhor as necessidades de cada cliente.

frontalImage

string <base64> | null

required

Arquivo binário com a imagem frontal do indivíduo. A imagem é codificada em string de texto conforme o padrão RFC3548 usando a codificação base64.

Match pattern:

RFC3548

requestId

string

required

Código único de identificação da solicitação ao servidor, que será registrado no histórico de consumo dos serviços.

elapsedMilliseconds

integer

required

Tempo de duração do processamento em milissegundos.

status

object

required

Objeto contendo o código de status e a mensagem de resposta.

code

integer

required

Código de status interno. Veja os valores possíveis nas mensagens de erro do mostQI.

message

string | null

required

Mensagem de retorno de status. Veja os valores possíveis nas mensagens de erro do mostQI.

errors

object

required

Example

{
  "result": {
    "globalScore": 1,
    "movementScore": 1,
    "livenessScore": 1,
    "imageScore": 1,
    "frontalImage": "base64"
  },
  "requestId": "xxxxxxxxxxxxxxxxxxxxx",
  "elapsedMilliseconds": 1000,
  "status": {
    "message": "Success",
    "code": "S100",
    "errors": null
  }
}

🟠400R101 A specified parameter is wrong

🟠401R117 Invalid authorization data

🔴500E100 The request could not be processed

Modified at 2024-11-28 14:21:48

Liveness Detection [multipart/form-data]

Liveness Streaming