Consultar Resultado Facematch

Requisição

GET [Url Ambiente]/Biometria/Consultar/{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/Consultar/58224'

Status Code 200

Retorno de sucesso.

Parâmetro	Descrição	Tipo	Exemplos
Sistema	Em qual sistema foi feita a análise	String	"Acertpix"
Metodo	Método usado na requisição	String	"API/Consultar"
Id	Id da análise	Int	58285
DataCadastro	Data que a análise foi cadastrada	Date	"2025-06-05T15:53:34"
Chave	Campo para identificação da analise	String	"ChaveDefinidaPeloCliente"
CPFCliente	CPF do cliente que foi enviado os documentos	String	"123.456.789.00"
TaxaSimilaridade	Similaridade entre as imagens	Decimal	99.1343
DataEnvio	Data de envio dos documentos	Date	"2025-06-05T15:53:34"
DataResposta	Data da resposta da análise	Date	"2025-06-05T15:53:34"
Status	Status da requisição	OK = 0, ERRO = 1	0
Mensagens	Descrição dos erros	String[]	["SUCESSO"]

Exemplo Json

{
  "Biometria": {
      "Sistema": "Acertpix",
      "Metodo": "API/Consultar",
      "Id": 195722,
      "DataCadastro": "2025-06-05T15:53:34",
      "Chave": "ChaveDefinidaPeloCliente",
      "CPFCliente": "12345678900",
      "TaxaSimilaridade": 99.1343,
      "DataEnvio": "2025-06-05T15:53:34",
      "DataResposta": "2025-06-05T15:53:34"
    },
    "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"
  ]
}