Consultar Analises

Requisição

GET [Url Ambiente]/Analises/Consultar

Header

Identificador	Valor
Accept	application/json
Authorization	Bearer [Valor do Token retornado na Autenticação]

Query

Parâmetro	Descrição	Tipo	Exemplos
Chave	Campo para identificação da requisição	String	"ChaveDefinidaPeloCliente"

Exemplo

curl -X GET --header 'Accept: application/json' --header 'Authorization: Bearer ababab1236-nbahdj-25' 'https://api.plataformaacertpix.com.br/Analises/Consultar?chave=aababab1236-ababab-5263'

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
Status	Status da requisição	String	'0' ou '1'
Mensagens	Descrição do status da requisição	String	"SUCESSO" ou "NÃO ENCONTRADO"
Sistema	Sistema responsável pela análise	String	AcertPix
Método	Método responsável pela consulta	String	"API/Consultar"
ID	ID da Análise (número interno AcertPix)	Int	1000
DataCadastro	Data de cadastro da análise	DataTime	2022-01-01T11:50:51
Chave	Campo chave da análise	String	“12121212abc”
CPFCliente	CPF enviado pelo cliente	String	“000.000.000-00”
Status	Status da Análise	String	Tabela
DataEnvio	Data de envio da análise	DataTime	2022-01-01T11:50:51
DataResposta	Data de envio da resposta	DataTime	2022-01-01T11:50:51
Motivo	Motivo do Status	Int	Tabela
MotivoTexto	Motivo do Status em texto	String	Tabela
Automatico	Formato da análise	String	'True' ou 'False'
TipoDocumento	Tipo do documento analisado	String	Tabela
Expedidor	Órgão expedidor do documento	String	"SSP"
Nome	Nome portador	String	"Nome Portador"
NomePai	Nome pai	String	"Nome Pai Portador"
NomeMae	Nome mãe	String	"Nome Mãe Portador"
DataNascimento	Data Nascimento	String	"dd/mm/aaaa"
DataExpedicao	Data de expedição do documento	String	"dd/mm/aaaa"
CPF	CPF do portador	String	“000.000.000-00”
EstadoEmissorCPF	Estado emissor do CPF	String	"Estado emissor"
DataDaPrimeiraEmissao	Data primeira emissão do documento	String	"dd/mm/aaaa"
Diretor	Diretor responsável por assinar o documento	String	"Nome Diretor"
Perfuracao	Perfuração	String	"XXII"
NumeroDocumento	Número de registro	String	"00.000.00-0"
RGCnh	Número doc. identidade na CNH	String	"00.000.00-0"
DataExpiracao	Data de expiração do documento	String	"dd/mm/aaaa"
NumeroSeguranca	Número de segurança da CNH	String	"00000000000"
Categoria	Categoria da CNH	String	"X"
Renach	Renach da CNH	String	"UF000000000"
NumeroFormulario	Número de formulário superior da CNH	String	"0000000000"
NumeroFormularioInferior	Número de formulário inferior da CNH	String	"0000000000"
EstadoDocumento	Estado emissor do documento	String	"UF"
Secretaria	Secretaria do documento	String	"Secretaria"
Instituto	Instituto do documento	String	"Instituto"
Permissao	Permissão da CNH	String	"0"
Naturalidade	Naturalidade	String	"Naturalidade UF"
Biometria	Facematch foto documento x selfie	String	Tabela
Titulo	Campo de informações gerais da Analise	String	"ID da Análise"
Campo	Campo da Validacao Analise	String	"Digito RG"
Valor	Valor Relativo ao Campo/Titulo	DataTime	"00.000.000-7"
MensagemValidacao	Resultado da Validacao	String	“Valido”
SubType	Subtipo de Outros documentos	String	"CTPS_FISICA"
BaseCadastral	Cadastral Base	String	"Serpro"
Score	Score	String	'0' a '1'

Exemplo Com Selfie Reconhecida

{
  "Status": 0,
  "Mensagens": [
        "SUCESSO"
  ],
  "Analise": {
    "Sistema": "Acertpix",
    "Metodo": "API/Consultar",
    "Id": 123456,
    "DataCadastro": "2022-05-26T22:09:46",
    "Chave": "abcabc554-52bnc-ababa",
    "CPFCliente": "01234567812",
    "DetalhesSolicitante": null,
    "Status": 4,
    "DataEnvio": "2022-05-26T22:09:49",
    "DataResposta": "2022-05-27T08:04:48",
    "Motivo": 7,
    "MotivoTexto": "Automático",
    "Automatico": false,
    "OCR": {
      "TipoDocumento": 1,
      "Expedidor": "XXXXX",
      "Nacionalidade": null,
      "Nome": "Nome Portador",
      "NomePai": "Nome Pai",
      "NomeMae": "Nome Mae",
      "ScoreSuspeito": 0,
      "DataNascimento": "00/00/0000",
      "DataExpedicao": "00/00/0000",
      "CPF": "012.345.678-12",
      "EstadoEmissorCPF": "Estado Emissor",
      "DataDaPrimeiraEmissao": "00/00/0000",
      "Diretor": null,
      "Brasao": null,
      "Perfuracao": null,
      "NumeroDocumento": "01234567891",
      "RGCnh": "12345678",
      "DataExpiracao": "00/00/0000",
      "NumeroSeguranca": "0000000000",
      "Categoria": "XX",
      "Renach": "UF000000000",
      "NumeroFormulario": "0000000000",
      "NumeroFormularioInferior": "0000000000",
      "EstadoDocumento": "UF",
      "EstadoRgFaceA": null,
      "Secretaria": null,
      "Instituto": null,
      "Permissao": 1,
      "DocOrigem": null,
      "Naturalidade": null,
      "Biometria": 1
    },
    "Laudo" : {
      "ConteudoPadraoAnalise": [
        {
          "Titulo": "string",
          "Valor": "string"
        }
      ],
      "ConteudoValidacaoDocumento": [
        {
          "Campo": "string",
          "Valor": "string",
          "MensagemValidacao": "string"
        }
      ]
    },
    "StatusBaseBiometria": null,
    "DescricaoBaseBiometria": null,
    "SubType": null
 },
  "Biometria": {
      "BaseCadastral": "Serpro",
      "Score": 0.948761596725722
  }
}

Exemplo Com Selfie Não Reconhecida

{
  "Status": 0,
  "Mensagens": [
        "SUCESSO"
  ],
  "Analise": {
    "Sistema": "Acertpix",
    "Metodo": "API/Consultar",
    "Id": 123456,
    "DataCadastro": "2022-05-26T22:09:46",
    "Chave": "abcabc554-52bnc-ababa",
    "CPFCliente": "01234567812",
    "DetalhesSolicitante": null,
    "Status": 4,
    "DataEnvio": "2022-05-26T22:09:49",
    "DataResposta": "2022-05-27T08:04:48",
    "Motivo": 7,
    "MotivoTexto": "Automático",
    "Automatico": false,
    "OCR": {
      "TipoDocumento": 1,
      "Expedidor": "XXXXX",
      "Nacionalidade": null,
      "Nome": "Nome Portador",
      "NomePai": "Nome Pai",
      "NomeMae": "Nome Mae",
      "ScoreSuspeito": 0,
      "DataNascimento": "00/00/0000",
      "DataExpedicao": "00/00/0000",
      "CPF": "012.345.678-12",
      "EstadoEmissorCPF": "Estado Emissor",
      "DataDaPrimeiraEmissao": "00/00/0000",
      "Diretor": null,
      "Brasao": null,
      "Perfuracao": null,
      "NumeroDocumento": "01234567891",
      "RGCnh": "12345678",
      "DataExpiracao": "00/00/0000",
      "NumeroSeguranca": "0000000000",
      "Categoria": "XX",
      "Renach": "UF000000000",
      "NumeroFormulario": "0000000000",
      "NumeroFormularioInferior": "0000000000",
      "EstadoDocumento": "UF",
      "EstadoRgFaceA": null,
      "Secretaria": null,
      "Instituto": null,
      "Permissao": 1,
      "DocOrigem": null,
      "Naturalidade": null,
      "Biometria": 1
    },
    "Laudo" : {
      "ConteudoPadraoAnalise": [
        {
          "Titulo": "string",
          "Valor": "string"
        }
      ],
      "ConteudoValidacaoDocumento": [
        {
          "Campo": "string",
          "Valor": "string",
          "MensagemValidacao": "string"
        }
      ]
    },
    "StatusBaseBiometria": null,
    "DescricaoBaseBiometria": null,
    "SubType": null
 },
  "Biometria": null
}

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"
  ]
}