Balcão INSS
Esta documentação tem como objetivo fornecer informações detalhadas sobre as APIs disponíveis para o INSS recuperar os dados de um cidadão de forma segura e eficiente. Descrição das entradas e saídas de cada API. As APIs foram projetadas para atender a diferentes necessidades, proporcionando uma experiência completa e personalizada para os usuários.
As APIs foram desenvolvidas com foco na segurança e privacidade das informações do cidadão. Para garantir a proteção dos dados sensíveis, todas as solicitações são processadas em ambiente criptografado, e apenas os dados estritamente necessários serão fornecidos em resposta às consultas realizadas.
Lembramos que o uso indevido ou não autorizado dessas APIs pode violar as leis de proteção de dados e privacidade vigentes. Portanto, é fundamental que o acesso às informações do cidadão seja utilizado exclusivamente para fins legais e autorizados pelas respectivas autoridades.
Consulta por CPF - Entrada
A API de consulta por CPF permite a recuperação dos dados de um cidadão com base em seu Cadastro de Pessoa Física (CPF). Ao utilizar esta API, você pode realizar consultas precisas e rápidas, obtendo informações detalhadas sobre o indivíduo em questão, contendo tanto dados textuais como também dados binários (imagens em base64).
https://api.mj.gov.br/idnacional/cidadaos/{cpf}
- cpf (String)
- Campo que contém o Número Único do Processo.O Número Único do Processo não pode ser maior que 11 caracteres; Deve ser alfa numéricos; E deve ser único (não estar sendo utilizado por outra identidade na base de dados).
Consulta por CPF - Saida
{
"hits": {
"hits": [
{
"_source": {
"enderecocidadao": "Blablabla",
"filiacao21": "FLAVIO SOARES DA SILVA",
"cpf": "02887318160",
"filiacao31": "FLAVIO SOARES DA SILVA",
"nome1": "Jessica Aquino",
"certidaonasccasamento": "Certd cas 14591409 Fls 59243014 Liv 8959115",
"nome2": null,
"enderecoresponsavel": "Groove",
"filiacao12cpf": "83848371472",
"ctps": "123",
"naturalidade": "RECIFE/PE",
"telefonecidadao": "12345678910110",
"cid": "123456",
"telefoneresponsavel": "01101987654321",
"datanascimento": "1979-07-06",
"nomesocial1": "Jessica Aquino",
"observacaosaude": "Blablabla",
"datavalidade": "2033-07-26",
"filiacao32cpf": "83848371472",
"rgs": "[{\"nrRG\":\"123456\",\"nmUF\":\"RN\",\"dtEmissao\":\"2022-11-14\"},{\"nrRG\":\"654321\",\"nmUF\":\"MG\",\"dtEmissao\":\"2022-11-14\"},{\"nrRG\":\"987654\",\"nmUF\":\"SP\",\"dtEmissao\":\"2022-11-14\"}]",
"cnh": "678",
"pispasep": "29354",
"nomeresponsavel": "Johnson",
"filiacao21cpf": "83848371472",
"nit": "6754",
"foto": "iVBORw0KGgoAAAANSUhEUgAAAoAAAALWCAMAAADhxNL7AAAACXBIWXMAAC4jAAAuIwF4pT92AAABBVBMVEX...",
"sexo": "F",
"estadocivil": "Casado(a)",
"tiponacionalidade": "Nato",
"filiacao11": "FLAVIO SOARES DA SILVA",
"filiacao32": "FLAVIO SOARES DA SILVA",
"polegardireito": "/6D/qAB6TklTVF9DT00gOQpQSVhfV0lEVEggODAwClBJWF9IRUlHSFQgODAwClBJWF9ERVBUSCA4ClBQSSA1MDAK...",
"nacionalidade": "BRA",
"nis": "4432",
"filiacao11cpf": "83848371472",
"filiacao22": "FLAVIO SOARES DA SILVA",
"validadeciptea": "2023-07-19T00:00:00.000Z",
"filiacao22cpf": "83848371472",
"nomesocial2": null,
"cpfresponsavel": "83848371472",
"emailresponsavel": "email@responsavel.com",
"filiacao12": "FLAVIO SOARES DA SILVA",
"filiacao31cpf": "83848371472",
"tiposanguineo": "A+",
"dataemissao": "2023-07-26"
}
}
]
}
}
- nome1 (String)
- Campo que contém o nome do cidadão.Tem o tamanho máximo de 255 caracteres.
- nome2 (String)
- Campo que contém o complemento do nome do cidadão.Tem o tamanho máximo de 37 caracteres.
- nomesocial1 (String)
- Campo que contém o nome social do cidadão.Tem o tamanho máximo de 255 caracteres.
- nomesocial2 (String)
- Campo que contém o complemento do nome social do cidadão.Tem o tamanho máximo de 37 caracteres.
- datanascimento (String)
- Campo que contém a data de nascimento do cidadão.Tem o tamanho máximo de 10 caracteres.
- dataemissao (String)
- Campo que contém a data de emissão da carteira de identidade digital do cidadão.Tem o tamanho máximo de 10 caracteres.
- cpf (String)
- Campo que contém o CPF do cidadão.Tem o tamanho máximo de 11 caracteres.
- validadeciptea (String)
- Campo que contém a data de validade da CIPTEA do cidadão.Tem o tamanho máximo de 10 caracteres.
- sexo (String, Obrigatório)
- Campo que contém o sexo do cidadão.Deve ter o tamanho igual a 1 caracter.Valores possíveis: M, F, X.
- filiacao11 (String)
- Campo que contém a filiacao11 do cidadão.Tem o tamanho máximo de 255 caracteres.
- filiacao12 (String)
- Campo que contém a filiacao12 do cidadão.Tem o tamanho máximo de 255 caracteres.
- filiacao21 (String)
- Campo que contém a filiacao21 do cidadão.Tem o tamanho máximo de 255 caracteres.
- filiacao22 (String)
- Campo que contém a filiacao22 do cidadão.Tem o tamanho máximo de 255 caracteres.
- filiacao31 (String)
- Campo que contém a filiacao31 do cidadão.Tem o tamanho máximo de 255 caracteres.
- filiacao32 (String)
- Campo que contém a filiacao32 do cidadão.Tem o tamanho máximo de 255 caracteres.
- filiacao11cpf (String)
- Campo que contém o cpf da filiacao11 do cidadão.Tem o tamanho de 11 caracteres.
- filiacao12cpf (String)
- Campo que contém o cpf da filiacao12 do cidadão.Tem o tamanho de 11 caracteres.
- filiacao21cpf (String)
- Campo que contém o cpf da filiacao21 do cidadão.Tem o tamanho de 11 caracteres.
- filiacao22cpf (String)
- Campo que contém o cpf da filiacao22 do cidadão.Tem o tamanho de 11 caracteres.
- filiacao31cpf (String)
- Campo que contém o cpf da filiacao31 do cidadão.Tem o tamanho de 11 caracteres.
- filiacao32cpf (String)
- Campo que contém o cpf da filiacao32 do cidadão.Tem o tamanho de 11 caracteres.
- emailresponsavel (String)
- Campo que contém o e-mail do responsável pelo cidadão com CIPTEA.Tem o tamanho de 80 caracteres.
- tiponacionalidade (String)
- Campo que contém o tipo de nacionalidade do cidadão.Tem o tamanho de 12 caracteres.
- cpfresponsavel (String)
- Campo que contém o cpf do responsável pelo do cidadão com CIPTEA.Tem o tamanho de 11 caracteres.
- nacionalidade (String)
- Campo que contém o nacionalidade do responsável pelo do cidadão.Tem o tamanho de 3 caracteres.
- telefoneresponsavel (String)
- Campo que contém o telefone do responsável pelo do cidadão com CIPTEA.Tem o tamanho de 14 caracteres.
- telefonecidadao (String)
- Campo que contém o telefone do cidadão com CIPTEA.Tem o tamanho de 14 caracteres.
- enderecocidadao (String)
- Campo que contém o endereço do cidadão.Tem o tamanho de 255 caracteres.
- enderecoresponsavel (String)
- Campo que contém o endereço do responsável pelo cidadão com CIPTEA.Tem o tamanho de 255 caracteres.
- cid (String)
- Campo que contém o CID do cidadão com CIPTEA.Tem o tamanho de 6 caracteres.
- nomeresponsavel (String)
- Campo que contém o nome do responsável pelo cidadão com CIPTEA.Tem o tamanho de 14 caracteres.
- datavalidade (String)
- Campo que contém a data de validade da carteira de identidade.Tem o tamanho máximo de 10 caracteres.
- naturalidade (String)
- Campo que recebe a naturalidade do cidadão.Tem o tamanho máximo igual a 38 caracteres.
- cnh (String)
- Campo que recebe a cnh do cidadão.Tem o tamanho máximo de 18 caracteres.
- pispasep (String)
- Campo que recebe o número do PIS/PASEP do cidadão.Tem o tamanho máximo de 14 caracteres.
- nis (String)
- Campo que recebe o nis (Número de Identificação Social) do cidadão.Tem o tamanho máximo de 14 caracteres.
- nit (String)
- Campo que recebe o nit (Número de Identificação do Trabalhador) do cidadão.Tem o tamanho máximo de 14 caracteres.
- ctps (String)
- Campo que recebe a ctps (Carteira de Trabalho e Previdência Social) do cidadão.Tem o tamanho máximo de 22 caracteres.
- cns (String)
- Campo que recebe a cns (Carteira Nacional de Saúde) do cidadão.Tem o tamanho máximo de 19 caracteres.
- observacaosaude (String)
- Campo que a observação de saúde do cidadão.Tem o tamanho máximo de 50 caracteres.
- rgs (String)
- Uma string de uma lista json que recebe vários conjuntos de RG: numeroRG, ufEmissaoRG, dataEmissaoRG.
- tiposanguineo (String)
- Campo que recebe o tipo sanguíneo do cidadão.Tem o tamanho máximo de 3 caracteres.
- estadocivil (String)
- Campo que recebe o estado civíl do cidadão.Tem o tamanho máximo de 13 caracteres.
- certidaonasccasamento (String)
- Campo que recebe a certidão de nascimento / casamento do cidadão.Tem o tamanho máximo de 120 caracteres.
- foto (String)
- Campo base64 que contém a foto do cidadão.No formato png ou jpeg.
- polegardireito (String)
- Campo base64 que contém a foto do polegar direito do cidadão.No formato wsq.