Liveness Streaming Status [application/json]

POST

https://mostqiapi.com/liveness/streaming/async/status

Last modified:2025-03-24 19:39:07

Esta rota permite consultar o status do processo de prova de vida solicitada na rota Liveness Streaming [application/json].

O status de um processo pode ser consultado por 1 hora após a requisição inicial, assegurando um tempo suficiente para monitoramento e retorno dos dados.

O status pode ser:

Status	Descrição
TODO	A prova de vida ainda não foi iniciada ou está em andamento.
DOING	A sessão de prova de vida foi iniciada, ou seja, o usuário clicou em "Iniciar captura" e o processo está em andamento.
DONE	A prova de vida foi concluída com sucesso. Nesse caso, o resultado conterá valores para os atributos frontalImage e livenessScore.
ERROR	Ocorreu um erro durante o processo de prova de vida.
EXPIRED	A sessão de prova de vida expirou. Isso ocorre quando o usuário não conclui a prova de vida dentro do prazo de 3 minutos após clicar em "Iniciar captura".

Request

Header Params

Authorization

string

required

Token de autorização obtido no método user/authenticate.

Example:

Bearer {{bearer_token}}

Body Params application/json

processId

string

required

Código identificador do processo obtido através da rota /liveness/streaming/async/.

Examples

Example 1Example 2

{
  "processId": "{{processID}}"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

cURL

Example 1Example 2

curl --location --request POST 'https://mostqiapi.com/liveness/streaming/async/status' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "processId": ""
}'

Responses

🟢200Ok

application/json

Body

result

object

required

Lista contendo o resultado do método.

processId

string

required

ID referente ao processo assíncrono de requisição ao Liveness Streaming, denominado "processId". Este id será utilizado para verificar o status do processo e acessar o resultado da prova de vida.

status

string

required

Status da prova de vida: TODO, DOING, DONE, ERROR OU EXPIRED.

livenessScore

integer

required

Pontuação de confiança (de 0 a 1) que indica a probabilidade de o usuário ser real e estar presente.

frontalImage

string <base64>

required

Arquivo binário com a imagem frontal capturada durante a prova de vida. A imagem é codificada em string de texto conforme o padrão RFC3548 usando a codificação base64.

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 e mensagem de status da resposta.

message

string | null

required

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

code

string

required

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

errors

object | null

required

Lista de objetos do tipo Error, o formato é variável.

Examples

TODODOINGDONEEXPIRED

{
  "result": {
    "processId": "dbf9e398-98de-41d3-8b95-525026c00f96",
    "status": "TODO",
    "livenessScore": null,
    "frontalImage": null
  },
  "requestId": "aeYmNfTUBs2zhWOB4to55",
  "elapsedMilliseconds": 314,
  "status": {
    "message": "Ok",
    "code": "200",
    "errors": null
  }
}

🟠400Invalid authentication data

🟠400R101 A specified parameter is wrong

🟠400R125 Process expired or not found with the given ID

Modified at 2025-03-24 19:39:07

Liveness Streaming [application/json]

MultiAddress Parsing