APIs
Inicia processo de análise de fraude
Inicie a análise de fraude informando o CPF do usuário, a imagem da selfie em Base64 e os dados de configuração do webhook para entrega do resultado.
POST
Inicia processo de análise de fraude
Use
Exemplo de sucesso (
POST /onboarding/api/v1/steps/fraud para iniciar o processo de análise de fraude. A requisição espera receber o CPF do usuário, a imagem da selfie em Base64 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 análise 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 para o processo de fraude.Exemplo:
12345678900string
required
Caminho de redirecionamento do aplicativo após a conclusão do processo.Exemplo:
/onboarding/redirectstring
Imagem da selfie do usuário em formato Base64.Exemplo:
aW1hZ2UtQmFzZTY0string
URL para notificação de webhook com o resultado final.Exemplo:
https://seusistema.com/webhookstring
Credenciais Basic Auth (
usuario:senha) para autenticação do webhook.Exemplo: usuario:senhaResponse
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 status400 (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_ERRORstring
required
Mensagem de erro.Exemplo:
The request is invalidobject[]
Lista contendo ou não um erro detalhado.
field(string): caminho do campo incorreto ou inválido. Exemplo:namemessage(string): mensagem de erro do campo. Exemplo:The field cannot be blank
Previous
Inicia processo de verificação de livenessInicie a verificação de vivacidade (liveness) informando o CPF do usuário e os dados de configuração do webhook para entrega do resultado.
Next
Inicia processo de análise de fraude