Enviar Documentos para Facematch Doc e Selfie
Para a melhor performance da validação automática em relação a qualidade de imagem do documento/selfie, os parâmetros de tamanho da imagem devem seguir os requisistos:
- tamanho mínimo: 100KB
- tamanho máximo: 4.5MB
- extensões: JPEG, PNG, PDF
Requisição
POST [Url Ambiente]/Biometria/Enviar
Header
| Identificador | Valor |
|---|---|
| Content-type | application/json |
| Accept | application/json |
| Authorization | Bearer [Valor do Token retornado na Autenticação] |
Body
| Parâmetro | Descrição | Tipo | Exemplos |
|---|---|---|---|
| Chave | Campo para identificação da analise | String | "ChaveDefinidaPeloCliente" |
| ImagemFrente | Imagem da frente do documento | Base64 | Base64 |
| ImagemVerso | Imagem do verso do documento | Base64 | Base64 |
| ImagemSelfie | Imagem da selfie | Base64 | Base64 |
| CPF | CPF para validação em bases cadastrais | String | "000.000.000-00" |
Exemplo
{
"Chave": "string",
"ImagemFrente": "string",
"ImagemVerso": "string",
"ImagemSelfie": "string",
"CPF": "string"
}
Status Code 200
Retorno de sucesso.
| Parâmetro | Descrição | Tipo | Exemplos |
|---|---|---|---|
| AnaliseId | Id da análise | Int | 58285 |
| Similaridade | Similaridade entre as imagens | String[] | ["-1 a 100"] |
| SelfieRecortada | Selfie Recortada em Base64 | String[] | ["Base64"] |
| LinkPDFResultado | Link para download do pdf | String[] | "https//test-api.acertpix.com.br:/Biometria/Enviar//Biometria/ObterPDF/58285" |
| Status | Status da requisição | OK = 0, ERRO = 1 | 0 |
| Mensagens | Descrição dos erros | String[] | ["SUCESSO"] |
Exemplo
{
"AnaliseId": 58285,
"Similaridade": -1,
"SelfieRecortada": null,
"LinkPDFResultado": "https//test-api.acertpix.com.br:/Biometria/Enviar//Biometria/ObterPDF/58285",
"Status": 0,
"Mensagens": [
"SUCESSO"
]
}
Status Code 401
Usuário/Senha inválidos.
| Parâmetro | Descrição | Tipo | Exemplos |
|---|---|---|---|
| Status | Status da requisição | OK = 0, ERRO = 1 | 1 |
| Mensagens | Descrição dos erros | String[] | "Mensagens": [] |
Status Code 404
Erro 404 - Url não encontrado
O erro 404 é exibido quando um endpoint especificado pelo usuário não é encontrado na API. Isso pode ocorrer quando o usuário digitou um URL incorreto ou quando o endpoint não está mais disponível.
Status Code 500
Erro não tratado pelo sistema.
| Parâmetro | Descrição | Tipo | Exemplos |
|---|---|---|---|
| Status | Status da requisição | OK/ERRO | ERRO |
| Mensagens | Descrição dos erros | String[] | "Mensagens": [] |
Exemplo
{
"Status": "OK",
"Mensagens": [
"string"
]
}