Skip to main content
POST
Inicia processo de verificação de liveness
Use POST /onboarding/api/v1/steps/liveness para iniciar o processo de verificação de vivacidade (liveness). A requisição espera receber o CPF do usuário e informações de configuração como a URL e dados de autenticação do webhook para entrega do resultado. Além dessas informações é possível utilizar URLs de redirecionamento e flags para páginas de introdução e sucesso. A API irá iniciar um novo processo de verificação de liveness e retornar o identificador do processo criado, a URL para acompanhar o processo e a data de criação. Requisito: é necessário enviar o header de autenticação, mais informações aqui

Request Body

string
required
CPF do indivíduo.Exemplo: 12345678900
string
required
Caminho de redirecionamento do aplicativo após a conclusão.Exemplo: /onboarding/liveness-success
string
URL para notificação de webhook com o resultado final.Exemplo: https://seusistema.com/webhook/liveness
string
Credenciais Basic Auth (usuario:senha) para autenticação do webhook.Exemplo: usuario:senha

Response

Retorna o identificador do processo criado, a URL de acompanhamento e a data de criação.

Exemplo de sucesso (200 OK)

string
required
URL para a próxima etapa ou visualização do recurso.
string
required
ID único da requisição iniciada.
string
required
Data e hora de criação da requisição.

Respostas de Erro

A API pode retornar os status 400 (Bad request), 422 (Validation or semantic error) e 500 (Internal server error), seguindo o modelo padrão de erro da aplicação.
string
required
Código do erro que categoriza o tipo de erro.Exemplo: VALIDATION_ERROR
string
required
Mensagem de erro.Exemplo: The request is invalid
object[]
Lista contendo ou não um erro detalhado.
  • field (string): caminho do campo incorreto ou inválido. Exemplo: name
  • message (string): mensagem de erro do campo. Exemplo: The field cannot be blank