Consultar por Facematch Doc e Selfie
Requisição
GET [Url Ambiente]/Biometria/ObterPDF/{id}
Header
| Identificador | Valor |
|---|---|
| Accept | application/json |
| Authorization | Bearer [Valor do Token retornado na Autenticação] |
Query
| Parâmetro | Descrição | Tipo | Exemplos |
|---|---|---|---|
| id | Campo para identificação da requisição | Int | 58224 |
Exemplo
curl -X GET --header 'Accept: application/json' --header 'Authorization: Bearer ababab1236-nbahdj-25' 'https://api.plataformaacertpix.com.br/Biometria/ObterPDF/58224'
Status Code 200
Retorno de sucesso.
Com acesso ao token e chave, será possível obter o retorno/consulta da análise. Segue campos que são retornados na consulta:
| Parâmetro | Descrição | Tipo | Exemplos |
|---|---|---|---|
| Arquivo Pdf | File | BiometriaResultado |
A cor do texto de taxa de similaridade varia conforme o valor:
| Faixa | Cor | Exemplos |
|---|---|---|
| >= 75 | Verde | 80 |
| > 30 e < 75 | Amarelo | 45 |
| <= 30 | Vermelho | 26 |
Exemplo
Status Code 400
Não encontrado.
| Parâmetro | Descrição | Tipo | Exemplos |
|---|---|---|---|
| Status | Status da requisição | OK = 0, ERRO = 1 | 1 |
| Mensagens | Descrição dos erros | String[] | "Mensagens": "Mensagens": [] |
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": "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"
]
}