INSS - Consulta em Lote
- Engenharia
O que é
A consulta INSS - Consulta em Lote permite verificar a situação cadastral de uma pessoa no INSS.
Sobre a requisição (REQUEST):
Método: POST
Endereço: URL Base + /api/maestro/inss/consulta-em-lote
URL Base: https://api.plexi.com.br/
Parâmetros do header
Nome | Tipo | Obrigatório? | Descrição |
|---|---|---|---|
Authorization | String | Sim | Chave de API gerada no cadastro no Plexi, prefixada com |
Callback | String | Não | URL para onde o resultado da requisição será enviado via HTTP POST. |
Parâmetros da queryString
Nome | Tipo | Obrigatório? | Descrição |
|---|---|---|---|
certificate | string | Sim | Certificado a ser utilizado para autenticação. |
Parâmetros do body
Nome | Tipo | Obrigatório? | Descrição |
|---|---|---|---|
cpf | string | Sim | CPF a ser pesquisado |
nome | string | Sim | Nome a ser pesquisado |
dataNascimento | string | Sim | Data de nascimento da pessoa a ser pesquisada |
nis | string | Sim | NIS a ser pesquisado |
cnpjEmpregador | string | Sim | CPNJ do empregador |
Estrutura da resposta
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 ocorreram erros. |
Exemplos de retornos quando você faz a requisição:
Status 201
Status 422
Resultados da pesquisa ( retornados no callback ou fazendo requisição à API de respostas )
Valores possíveis do campo “status“
Status | Significado |
|---|---|
protocolado | A solicitação foi processada com sucesso |
erro | Ocorreu erro na solicitação |
Resposta com registro encontrado
{
"status": "protocolado",
"nomeArquivo": "D.CNS.CPF.000.000000000.00000000000.0000000000.TXT",
}Resposta com erro
{
"status": "erro",
"mensagem": "Mensagem de erro"
}
Sobre a requisição (SEARCH):
Método: POST
Endereço: URL Base + /api/maestro/result/{requestId}
URL Base: https://api.plexi.com.br/
Parâmetros do header
Nome | Tipo | Obrigatório? | Descrição |
|---|---|---|---|
Authorization | String | Sim | Chave de API gerada no cadastro no Plexi, prefixada com |
Callback | String | Não | URL para onde o resultado da requisição será enviado |
Resposta com registro encontrado
{
"resultados": [
{
"cpf": "00000000000",
"nis": "00000000000",
"nome": "FULANO DE TAL",
"dataNascimento": "1999-01-01",
"codigoNisInvalido": 0,
"codigoCpfInvalido": 0,
"codigoNomeInvalido": 0,
"codigoDataNascimentoInvalido": 0,
"codigoCnisNis": 0,
"codigoCnisDataNascimento": 0,
"codigoCnisObito": 0,
"codigoCnisCpf": 0,
"codigoCnisCpfNaoInformado": 0,
"codigoCpfNaoConsta": 0,
"codigoCpfNulo": 0,
"codigoCpfCancelado": 0,
"codigoCpfSuspenso": 0,
"codigoCpfDataNascimento": 0,
"codigoCpfNome": 0,
"codigoOrientacaoCpf": 0,
"codigoOrientacaoNis": 0
}
],
"dataProcessamento": "2025-03-25 23:59:24",
"dataEnvio": "2025-03-25 11:12:45"
}Resposta com erro
{
"status": "erro",
"mensagem": "Mensagem de erro"
}