Conheça a nossa nova rota Liveness Streaming!

Liveness Streaming [application/json]

POST

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

Last modified:2025-03-25 15:30:53

Nesta rota é solicitada a geração de um link para iniciar a avaliação do Liveness Streaming, criando um processo assíncrono.
Você pode configurar os seguintes elementos para oferecer uma experiência totalmente personalizada aos seus usuários:

Cor primária.

Tema.

Título de boas-vindas no início.

Mensagem de sucesso ao final processo.

Mensagem de falha ao final processo.

Idiomas pt-BR, en, es e fr.

Além de poder definir um endpoint de callback para receber notificações quando o processo for concluído.

Request

Header Params

Authorization

string

optional

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

Example:

Bearer {{bearer_token}}

Body Params application/json

webhook

object

optional

url

string

optional

É a URL em que será feita a chamada quando o processo assíncrono finalizar.

fallbackUrl

string

optional

Parâmetro que permite especificar outra URL caso haja falha de comunicação na chamada da URL especificada no parâmetro webhookUrl ou webhook.fallbackUrl.

authorization

object

optional

uiCustomization

object

optional

Objeto que define as configurações de idioma, tema e mensagens personalizadas para a interface exibida ao usuário durante o processo de liveness.

defaultLanguage

string

optional

Define o idioma padrão da interface. Valores aceitos:

pt-BR

fr.

Caso não seja informado, o idioma padrão será en (Inglês).

Example:

pt-BR

theme

string

optional

Define o tema da interface. Valores aceitos:

light (Claro)

dark (Escuro)

Caso não seja informado, o tema padrão será light.

Example:

dark

primaryColor

string

optional

Define a cor principal da interface no formato hexadecimal.

Example:

#1B406A

welcomeMessage

object

optional

Mensagem exibida como título na tela inicial do processo de verificação de liveness. É possível definir uma mensagem personalizada para cada idioma.

successMessage

object

optional

Mensagem de sucesso apresentada ao final do processo de verificação de liveness. Você pode definir uma mensagem para cada idioma, caso deseje personalizar a experiência do usuário.

failureMessage

object

optional

Mensagem exibida ao final do processo quando a verificação de liveness não for bem-sucedida. Você pode personalizar essa mensagem para cada idioma, se desejar.

Examples

ExampleExample 2

{
  "webhook": {
    "url": "string",
    "fallbackUrl": "string",
    "authorization": {
      "headers": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "queryStrings": [
        {
          "name": "string",
          "value": "string"
        }
      ]
    }
  },
  "uiCustomization": {
    "defaultLanguage": "string",
    "theme": "string",
    "primaryColor": "string",
    "welcomeMessage": {
      "ptBR": "string",
      "en": "string",
      "es": "string",
      "fr": "string"
    },
    "successMessage": {
      "ptBR": "string",
      "en": "string",
      "es": "string",
      "fr": "string"
    },
    "failureMessage": {
      "ptBR": "string",
      "en": "string",
      "es": "string",
      "fr": "string"
    }
  }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

cURL

ExampleExample 2

curl --location --request POST 'https://mostqiapi.com/liveness/streaming/async' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "webhook": {
        "url": "string",
        "fallbackUrl": "string",
        "authorization": {
            "headers": [
                {
                    "name": "string",
                    "value": "string"
                }
            ],
            "queryStrings": [
                {
                    "name": "string",
                    "value": "string"
                }
            ]
        }
    },
    "uiCustomization": {
        "defaultLanguage": "string",
        "theme": "string",
        "primaryColor": "string",
        "welcomeMessage": {
            "ptBR": "string",
            "en": "string",
            "es": "string",
            "fr": "string"
        },
        "successMessage": {
            "ptBR": "string",
            "en": "string",
            "es": "string",
            "fr": "string"
        },
        "failureMessage": {
            "ptBR": "string",
            "en": "string",
            "es": "string",
            "fr": "string"
        }
    }
}'

Responses

🟢200Success

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.

sessionUrl

string

required

Link único para acessar a página web onde a prova de vida será realizada. Esse link é válido apenas para uma única verificação, garantindo a segurança e a integridade do processo. Após o uso, o link se torna inválido.

urlExpiresAt

string

required

Data e hora de expiração do link gerado, representada em UTC. Após esse período, o link não poderá mais ser utilizado, mesmo que a prova de vida não tenha sido realizada.

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

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.

Example

{
  "result": {
    "processId": "eb2bf100-0376-46f9-8147-1b7ed36a39f0",
    "sessionUrl": "https://liveness.mostqi.com/?session=ImV5SmhiR2NpT2lKQk1USTRTMWNpTENKbGJtTWl...",
    "urlExpiresAt": "2025-03-11T19:36:41Z"
  },
  "requestId": "IRHJGf2pmp2HKbD44Uus5",
  "elapsedMilliseconds": 3488,
  "status": {
    "message": "Ok",
    "code": "200",
    "errors": null
  }
}

🟠401R117 Invalid authorization data

🔴500E100 The request could not be processed

Modified at 2025-03-25 15:30:53

Interface Web para prova de vida

Liveness Streaming Status [application/json]