INSS - Qualificação Cadastral

O que é

Nesta consulta você verifica se um um trabalhador está apto à utilização do eSocial.

O eSocial é um projeto com o objetivo de unificar informações que o empregador envia ao governo, sobre seus trabalhadores.

Os documentos informados na pesquisa são do trabalhador.

Veja mais informações em nossa central de ajuda: INSS - Qualificação Cadastral

Sobre a requisição:

Método: POST

Endereço: URL Base + /api/maestro/inss/qualificacao-cadastral

URL Base:

Parâmetros do header

Nome

Tipo

Obrigatório?

Descrição

Nome

Tipo

Obrigatório?

Descrição

Authorization

String

Sim

Chave de API gerada no cadastro no Plexi, prefixada com Bearer

Callback

String

Não

URL para onde o resultado da requisição será enviado via HTTP POST.

Parâmetros do body

Nome

Tipo

Obrigatório?

Descrição

Nome

Tipo

Obrigatório?

Descrição

cpf

String

Sim

CPF a ser pesquisado, com ou sem máscara. Exemplos: 99999999999 ou 999.999.999-99

nome

String

Sim

Nome da pessoa

nis

String

Sim

NIS, com ou sem máscara

dataNascimento

String

Sim

Data de nascimento no formato dd/mm/aaaa ( dia/mês/ano )

Retornos possíveis da requisição

Status

Significado

Descrição

Informações retornadas

Status

Significado

Descrição

Informações retornadas

201

Created

Solicitação criada

Campo requestId, com o ID da requisição criada.

422

Unprocessable Entity

A solicitação contém erro

Em quais campos houve erro.

Exemplos de retornos

Status 201

1 2 3 {   "requestId": "1fdd4247-4f98-4113-887a-b182117b0e42" }

Status 422

1 2 3 4 5 6 7 8 9 10 11 {   "message": "The given data was invalid.",   "errors": {     "cpf": [       "O campo cpf é obrigatório."     ],     "nome": [       "O campo name é obrigatório."     ]   } }

 

Resultados da pesquisa ( retornados no callback ou fazendo requisição à API de respostas )

Valores possíveis do campo “status“

Status

Significado

Status

Significado

invalido

Ocorre quando algum dado informado está divergente do cadastro

valido

Ocorre quando todos os dados informados estão corretos

Resposta com registro encontrado

1 2 3 4 5 6 7 8 9 10 11 { "status": "valido", "nomeInformado": "FULANO DA SILVA", "dataNascimentoInformado": "01/01/1960", "cpfInformado": "999.999.999-99", "nisInformado": "9.999.999.999-9", "mensagens": [ "Os dados estão corretos" ] "pdf": "JVBERi0xLjQKMSAwIG9iago8..." }
1 2 3 4 5 6 7 8 9 10 11 12 13 { "status": "invalido", "nomeInformado": "FULANO DA SILVA", "dataNascimentoInformado": "01/01/1960", "cpfInformado": "999.999.999-99", "nisInformado": "9.999.999.999-9", "mensagens": [ "PIS com data de nascimento divergente", "O nome informado é diferente da existente no Cadastro do CPF", "A data de nascimento informada é diferente da existente no Cadastro CPF" ], "pdf": "JVBERi0xLjQKMSAwIG9iago8..." }