Validacao de Pessoa Física

Requisição

GET [Url Ambiente]/Validacao/Valida-PF

Header

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

Query

Parâmetro	Descrição	Tipo	Exemplos
Nome	Campo a ser comparado com o Bureau de dados	String	"Nome Exemplo"
Cpf	Campo a ser comparado com o Bureau de dados	String	"000.000.000-00"
DataNascimento	Campo a ser comparado com o Bureau de dados	String	"dd/mm/aaaa"

Exemplo

curl -X POST --header 'Accept: application/json' --header 'Authorization: Bearer ababab1236-nbahdj-25' 'https://api.plataformaacert.com.br/Validacao/Valida-PF'
--data '{
    "Nome": "Nome Exemplo",
    "Cpf": "000.000.000-00",
    "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
Cpf	CPF enviado na requisição	String	“000.000.000-00”
Nome	Nome enviado na requisição	String	"Nome Exemplo"
DataNascimento	Data Nascimento enviada na requisição	String	"dd/mm/aaaa"
RegularReceita	Retorna se está regular na receita federal	String	"SIM" / "NÃO"
ObitoOK	Retorna se esta pessoa veio está em situação de Óbito	String	"SIM" / "NÃO"
NomeOK	Retorna se o Nome está ok em relação ao Bureau de dados	String	"SIM" / "NÃO"
NomeBureau	Nome retornado pelo Bureau de dados	String	"Nome Exemplo"
NascimentoOK	Retorna se a Data de Nascimento está ok em relação ao Bureau de dados	String	"SIM" / "NÃO"
NascimentoBureau	Data Nascimento retornada pelo Bureau de dados	String	"dd/mm/aaaa"
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": {
    "DadosValidacao": {
      "Nome": "Nome Exemplo",
      "Cpf": "00000000000",
      "DataNascimento": "01/11/2000"
    },
    "ResultadoValidacao": {
      "RegularReceita": "SIM",
      "ObitoOK": "SIM",
      "NomeOK": "SIM",
      "NomeBureau": "Nome Exemplo",
      "NascimentoOK": "SIM",
      "NascimentoBureau": "01/11/2000"
    }
  },
  "Status": 0,
  "Mensagens": [
    "SUCESSO"
  ]
}

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