E-Social

O aplicativo de Consulta Qualificação Cadastral permite ao usuário verificar se o Cadastro de Pessoa Física-CPF e o Número de Identificação Social-NIS (NIT/PIS/PASEP) estão aptos para serem utilizados no eSocial.

Request

GET /esocial-qualificacao-cadastral

Parâmetros

Parâmetro	Descrição	Obrigatório
taxId	CPF	Sim
birthdate	Data de Nascimento	Sim
nis	NIS	Sim
name	Nome	Sim

Response

Campo	Descrição	Tipo
id	ID único da requisição	String
version	Versão da API	String
data	Objeto com o resultado da busca	Object
data.cpf	CPF consultado	String
data.eSocialQualificacaoCadastral	Objeto com o resultado da busca	Object
data.eSocialQualificacaoCadastral.nome	Nome da pessoa consultada	String
data.eSocialQualificacaoCadastral.cpf	CPF da pessoa consultada	String
data.eSocialQualificacaoCadastral.nis	NIS da pessoa consultada	String
data.eSocialQualificacaoCadastral.mensagem	mensagem retornada na consulta	String
data.eSocialQualificacaoCadastral.orientacao	orientação retornada na consulta	String
data.eSocialQualificacaoCadastral.urlComprovante	URL do comprovante da consulta realizada	String

Exemplo Request

GET /esocial-qualificacao-cadastral?taxId=11111111111&name=Maria da Silva&birthdate=01/01/2001&nis=00000000000

TIP

O CPF pode ser passado com ou sem máscara (11111111111 111.111.111-11) e deve ser passado todos os chars, incluindo os zeros à esquerda.

Exemplos JSON

Veja alguns exemplos em JSON da resposta.

1. Exemplo quando dados encontrados

Status Code: 200

{
    "cpf": "00000000000000",
    "eSocialQualificacaoCadastral": {  
          "nome": "Fulana",  
          "dataNascimento": "10/10/2010", 
          "cpf": "022.022.022-00", 
          "nis": "0.000.000.000-0", 
          "mensagem": "O nome existente no cadastro do CPF é : Ciclano", 
          "orientacao": " Verifique os dados digitados. Se estiverem corretos, dirija-se a uma agência do Banco do Brasil ou Correios, entidades autorizadas pela RFB, para regularização do CPF.", 
          "urlComprovante": "https://..." 
    }
}