Documentação Técnica

Qualificação Cadastral no E-Social

Descrição

A consulta de Qualificação Cadastral do E-Social retorna o status do cadastro no indivíduo dentro do e-social. Embora a consulta no site exija o número de identificação do trabalhador (NIT) como um parâmetro de entrada, ele não é obrigatório para esse dataset. Caso não seja informado, será utilizada a informação de NIT disponível dentro da base da BigData Corp. Todos os dados de consultas online executadas em um modelo "on-demand" são retornados em uma mesma estrutura de objetos, e os objetos em si são retornados no campo de OnlineQueries do objeto principal de retorno.

Origem da Informação

As informações retornadas nesta consulta são retiradas da consulta pública de qualificação cadastral do e-social. O link de acesso a essa consulta pode ser visto aqui.

Tabela de preços para esse dataset

Consultas Realizadas no MêsValor por consulta
1 - 10000R$ 0,090
10001 - 50000R$ 0,085
50001 - 100000R$ 0,081
100001 e acimaR$ 0,077

Parâmetros de consulta

A tabela abaixo detalha os campos aceitos na consulta a este dataset.

CampoDescriçãoValores PossíveisTipo de Campo
docDocumento de identificaçãoCPF🛑 Obrigatório
nitNúmero de Inscrição do TrabalhadorQualquer NIT válidoℹ️  Opcional

Clique aqui para saber mais sobre os parâmetros de consulta da Plataforma de Dados.

Abaixo está um exemplo de como realizar a chamada apenas com os parâmetros obrigatórios:

{  
    "Datasets": "ondemand_esocial_certificate_person",
    "q": "doc{CPF}"  
}  

Descrição dos campos do objeto principal de retorno

CampoDescrição
OriginFonte dos Dados Entregues
InputParametersParâmetros de entrada
QueryDateData de realização da consulta.
QueryResultData.DataVerificationStatusVersão padronizada da mensagem de status da validação cadastral
QueryResultData.InputDocNumberNúmero de CPF informado na consulta
QueryResultData.InputNameNome informado na consulta
QueryResultData.InputBirthDateData de nascimento informada na consulta
QueryResultData.InputPISNúmero do PIS informado na consulta
QueryResultData.QueryResultMessageMensagem retornada pelo site para a consulta
QueryResultData.QueryResultOrientationsMensagem adicional (de orientações) retornada pelo site
Language
Authorization
Click Try It! to start a request and see the response here!