Checar Dados de Pessoa Física

Requisição

GET [Url Ambiente]/Validacao/ChecarDados-PF

Header

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

Query

Parâmetro	Descrição	Tipo	Exemplos
Cpf	Campo utilizado para buscar informações para validação	String	"000.000.000-00"
Nome	Nome a ser comparado com a base de dados	String	"Nome Exemplo"
NomeMae	Nome da Mãe a ser comparado com a base de dados	String	"Nome Exemplo"
NomePai	Nome do Pai a ser comparado com a base de dados	String	"Nome Exemplo"
DataNascimento	Data de Nascimento a ser comparado com a base de dados	String	"dd/mm/aaaa"

Exemplo

curl -X POST --header 'Accept: application/json' --header 'Authorization: Bearer ababab1236-nbahdj-25' 'https://api.plataformaacertpix.com.br/Validacao/ChecarDados-PF'
--data '{
    "Cpf": "000.000.000-00",
    "Nome": "Nome Exemplo",
    "NomeMae": "Nome Exemplo",
    "NomePai": "Nome Exemplo",
    "DataNascimento": "01/11/2000"
}'

Status Code 200

Retorno de sucesso.

Com acesso ao token e campos para validação, será possível obter o retorno da validação de Pessoa Física. Segue campos que são retornados na consulta:

Parâmetro	Descrição	Tipo	Exemplos
Id	Id único da validação	String	"3fa85f64-5717-4562-b3fc-2c963f66afa6"
Validacao.Status	Status de retorno da validação	String	Tabela de Status
Status	Status da requisição	String	'0' ou '1'
Mensagens	Descrição do status da requisição	String	"SUCESSO" ou "NÃO ENCONTRADO"

Exemplo

{
  "Validacao": {
    "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "Status": 1
  },
  "Status": 0,
  "Mensagens": [
    "string"
  ]
}

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