Segurança Pública
Esta documentação tem como objetivo fornecer informações detalhadas sobre as APIs disponíveis para Segurança Pública 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/pf/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",
"filiacao12abreviada": "FLAVIO SOARES DA SILVA",
"filiacao21": "FLAVIO SOARES DA SILVA",
"estadoemissao": "Distrito Federal",
"versoidentidade": "iVBORw0KGgoAAAANSUhEUgAAAZUAAALQCAYAAABYJu15AACAAElEQVR4Xuy9B5hdV3kunAaE...",
"flagautismo": false,
"cpf": "02887318160",
"situacao": 1,
"filiacao31": "FLAVIO SOARES DA SILVA",
"nome1": "Jessica Aquino",
"filiacao11abreviada": "FLAVIO SOARES DA SILVA",
"certidaonasccasamento": "Certd cas 14591409 Fls 59243014 Liv 8959115",
"nome2": null,
"cns": "456",
"enderecoresponsavel": "Groove Street",
"filiacao32abreviada": "FLAVIO SOARES DA SILVA",
"filiacao12cpf": "83848371472",
"filiacao31abreviada": "FLAVIO SOARES DA SILVA",
"frenteidentidade": "iVBORw0KGgoAAAANSUhEUgAAAZUAAALQCAYAAABYJu15AACAAElEQVR4Xuy997dtW1Xvef6Aaq2q1Q...",
"uuid": "cf648887-9230-416c-b1f0-38544a816131",
"ctps": "123",
"flagdeficienciaauditiva": false,
"naturalidade": "RECIFE/PE",
"orgaoexpedidor2": "teste",
"telefonecidadao": "12345678910110",
"filiacao22abreviada": "FLAVIO SOARES DA SILVA",
"cid": "123456",
"telefoneresponsavel": "01101987654321",
"datanascimento": "1979-07-06",
"nomesocial1": "Jessica Aquino",
"observacaosaude": "Estresse",
"orgaoexpedidor1": "SDS/PE",
"datavalidade": "2033-07-26",
"filiacao32cpf": "83848371472",
"qrcode": "iVBORw0KGgoAAAANSUhEUgAAAtAAAALQCAYAAAC5V0ecAACAAElEQVR4XuydbWpkV5a1u4oGzUEmp1FCHoV5q5rULO...",
"ufemissao": "GO",
"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\"}]",
"flagdeficienciafisica": false,
"cnh": "678",
"pispasep": "29354",
"nomeresponsavel": "Carl Johnson",
"cddedo": null,
"nome1abreviado": "Jessica Aquino",
"filiacao21cpf": "83848371472",
"flagdeficienciaintelectual": false,
"nit": "6754",
"foto": "iVBORw0KGgoAAAANSUhEUgAAAoAAAALWCAMAAADhxNL7AAAACXBIWXMAAC4jAAAuIwF4pT92AAABBVBMVEX...",
"tituloeleitor": "78964039",
"sexo": "F",
"localemissao": null,
"estadocivil": "Casado(a)",
"nome2abreviado": null,
"tiponacionalidade": "Nato",
"filiacao11": "FLAVIO SOARES DA SILVA",
"filiacao32": "FLAVIO SOARES DA SILVA",
"cidadeemissao": "Goiânia",
"polegardireito": "/6D/qAB6TklTVF9DT00gOQpQSVhfV0lEVEggODAwClBJWF9IRUlHSFQgODAwClBJWF9ERVBUSCA4ClBQSSA1MDAK...",
"nacionalidade": "BRA",
"nis": "4432",
"filiacao11cpf": "83848371472",
"flagdeficienciavisual": false,
"filiacao22": "FLAVIO SOARES DA SILVA",
"validadeciptea": "2023-07-19T00:00:00.000Z",
"filiacao22cpf": "83848371472",
"nomesocial2": null,
"cpfresponsavel": "83848371472",
"emailresponsavel": "email@responsavel.com",
"filiacao21abreviada": "FLAVIO SOARES DA SILVA",
"filiacao12": "FLAVIO SOARES DA SILVA",
"filiacao31cpf": "83848371472",
"tiposanguineo": "A+",
"dataemissao": "2023-07-26",
"orgaoemissor": "Secretaria de Segurança Pública"
}
}
]
}
}
- uuid (String)
- Campo que contém o uuid do cidadão.Tem o tamanho igual a 36 caracteres.
- 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.
- situacao (Number)
- Campo que contém a situação da identidade digital do cidadão.Tem o tamanho máximo de 11 caracteres.0 - Inativo1 - Ativo2 - Cancelada
- 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.
- 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.
- telefonecidadao (String)
- Campo que contém o telefone do cidadão com CIPTEA.Tem o tamanho de 14 caracteres.
- nomeresponsavel (String)
- Campo que contém o nome do responsável pelo cidadão com CIPTEA.Tem o tamanho de 255 caracteres.
- datavalidade (String)
- Campo que contém a data de validade da carteira de identidade.Tem o tamanho máximo de 10 caracteres.
- nome1abreviado (String)
- Campo que recebe a parte final do nome do cidadão.Tem o tamanho máximo de 37 caracteres.
- naturalidade (String)
- Campo que recebe a naturalidade do cidadão.Tem o tamanho máximo igual a 38 caracteres.
- orgaoexpedidor1 (String)
- Campo que recebe a parte inicial do orgão expedidor do documento.Tem o tamanho máximo de 37 caracteres.
- orgaoexpedidor2 (String)
- Campo que recebe a parte final do orgão expedidor do documento.Tem o tamanho máximo de 37 caracteres.
- localemissao (String)
- Campo que recebe o local emissão do documento.Tem o tamanho máximo de 37 caracteres.
- cidadeemissao (String)
- Campo que recebe a cidade de emissão do documento.Tem o tamanho máximo de 33 caracteres.
- ufemissao (String)
- Campo que recebe a UF da emissão do documento.Tem o tamanho máximo de 2 caracteres.
- flagdeficienciafisica (Boleano)
- Campo que recebe a flag que indica se o cidadão tem deficiência física.Valores possíveis: false e true.false é igual - falsotrue é igual - verdadeiro
- flagdeficienciaauditiva (Boleano)
- Campo que recebe a flag que indica se tem o cidadão possui deficiência auditiva.Valores possíveis: false e true.false é igual - falsotrue é igual - verdadeiro
- flagdeficienciaintelectual (Boleano)
- Campo recebe a flag que indica se o cidadão possui deficiência intelectual.Valores possíveis: false e true.false é igual - falsotrue é igual - verdadeiro
- flagdeficienciavisual (Boleano)
- Campo recebe a flag que indica se o cidadão possui deficiência visual.Valores possíveis: false e true.false é igual - falsotrue é igual - verdadeiro
- flagdeficienciaautismo (Boleano)
- Campo recebe a flag que indica se o cidadão possui autismo.Valores possíveis: false e true.false é igual - falsotrue é igual - verdadeiro
- 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.
- estadoemissao (String)
- Campo que recebe o Estado Emissão.Tem o tamanho máximo de 29 caracteres.
- 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.
- orgaoemissor (String)
- Campo que recebe o Orgão Emissor.Tem o tamanho máximo de 53 caracteres.
- filiacao11abreviada (String)
- Campo que recebe a abreviação do campo filiacao11 do cidadão.Tem o tamanho máximo de 37 caracteres.
- filiacao12abreviada (String)
- Campo que recebe a abreviação do campo filiacao12 do cidadão.Tem o tamanho máximo de 37 caracteres.
- filiacao21abreviada (String)
- Campo que recebe a abreviação do campo filiacao21 do cidadão.Tem o tamanho máximo de 37 caracteres.
- filiacao22abreviada (String)
- Campo que recebe a abreviação do campo filiacao22 do cidadão.Tem o tamanho máximo de 37 caracteres.
- filiacao31abreviada (String)
- Campo que recebe a abreviação do campo filiacao31 do cidadão.Tem o tamanho máximo de 37 caracteres.
- filiacao32abreviada (String)
- Campo que recebe a abreviação do campo filiacao32 do cidadão.Tem o tamanho máximo de 37 caracteres.
- certidaonasccasamento (String)
- Campo que recebe a certidão de nascimento / casamento do cidadão.Tem o tamanho máximo de 120 caracteres.
- cddedo (String)
- Tem o tamanho máximo de 2 caracteres;
- tituloeleitor (String)
- Campo que recebe o título eleitor do cidadão.Tem o tamanho máximo de 14 caracteres.
- foto (String)
- Campo base64 que contém a foto do cidadão.No formato png ou jpeg.
- frenteidentidade (String)
- Campo base64 que contém a frente da identidade digital do cidadão.No formato png.
- versoidentidade (String)
- Campo base64 que contém a frente da identidade digital do cidadão.No formato png.
- qrcode (String)
- Campo base64 que contém o qr code com os dados do cidadão.No formato png.
- polegardireito (String)
- Campo base64 que contém a foto do polegar direito do cidadão.No formato wsq.
Recuperar por Dados Avançados - Entrada
A API de consulta por Dados Avançados permite a recuperação dos dados de um cidadão com base no nome, filiação e data de nascimento. 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 binários (imagens em base64).
https://api.mj.gov.br/idnacional/pf/cidadaos
{
"nome": "Jessica",
"dataNascimento": "06/07/1979",
"filiacao1": "FLAVIO SOARES",
"filiacao2": "FLAVIO SOARES",
"from": 0,
"size": 10
}
- nome (String, Obrigatório)
- Campo que recebe o nome do cidadão.
- dataNascimento (String, Obrigatório)
- Campo que recebe o nome do cidadão.
- filiacao1 (String, Obrigatório)
- Campo que recebe uma filiação do cidadão.
- filiacao2 (String, Opcional)
- Campo que recebe uma filiação do cidadão.
- from (String, Obrigatório)
- Campo que recebe o início da lista paginada de cidadão que atendem os requisitos (nome / filiação / data de nascimento).Deve ser maior ou igual a zero
- size (String, Obrigatório)
- Campo que recebe o fim da lista paginada de cidadão que atendem os requisitos (nome / filiação / data de nascimento).Deve ser maior que zero e menor ou igual a 100
Recuperar por Dados Avançados - Saída
{
"hits": {
"hits": [
{
"_source": {
"enderecocidadao": "Blablabla",
"filiacao12abreviada": "FLAVIO SOARES DA SILVA",
"filiacao21": "FLAVIO SOARES DA SILVA",
"estadoemissao": "Distrito Federal",
"flagautismo": false,
"cpf": "02887318160",
"situacao": 1,
"filiacao31": "FLAVIO SOARES DA SILVA",
"nome1": "Jessica Aquino",
"filiacao11abreviada": "FLAVIO SOARES DA SILVA",
"certidaonasccasamento": "Certd cas 14591409 Fls 59243014 Liv 8959115",
"nome2": null,
"cns": "456",
"enderecoresponsavel": "Groove Street",
"filiacao32abreviada": "FLAVIO SOARES DA SILVA",
"filiacao12cpf": "83848371472",
"filiacao31abreviada": "FLAVIO SOARES DA SILVA",
"uuid": "cf648887-9230-416c-b1f0-38544a816131",
"ctps": "123",
"flagdeficienciaauditiva": false,
"naturalidade": "RECIFE/PE",
"orgaoexpedidor2": "teste",
"telefonecidadao": "12345678910110",
"filiacao22abreviada": "FLAVIO SOARES DA SILVA",
"cid": "123456",
"telefoneresponsavel": "01101987654321",
"datanascimento": "1979-07-06",
"nomesocial1": "Jessica Aquino",
"observacaosaude": "Estresse",
"orgaoexpedidor1": "SDS/PE",
"datavalidade": "2033-07-26",
"filiacao32cpf": "83848371472",
"ufemissao": "GO",
"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\"}]",
"flagdeficienciafisica": false,
"cnh": "678",
"pispasep": "29354",
"nomeresponsavel": "Carl Johnson",
"cddedo": null,
"nome1abreviado": "Jessica Aquino",
"filiacao21cpf": "83848371472",
"flagdeficienciaintelectual": false,
"nit": "6754",
"tituloeleitor": "78964039",
"sexo": "F",
"localemissao": null,
"estadocivil": "Casado(a)",
"nome2abreviado": null,
"tiponacionalidade": "Nato",
"filiacao11": "FLAVIO SOARES DA SILVA",
"filiacao32": "FLAVIO SOARES DA SILVA",
"cidadeemissao": "Goiânia",
"nacionalidade": "BRA",
"nis": "4432",
"filiacao11cpf": "83848371472",
"flagdeficienciavisual": false,
"filiacao22": "FLAVIO SOARES DA SILVA",
"validadeciptea": "2023-07-19T00:00:00.000Z",
"filiacao22cpf": "83848371472",
"nomesocial2": null,
"cpfresponsavel": "83848371472",
"emailresponsavel": "email@responsavel.com",
"filiacao21abreviada": "FLAVIO SOARES DA SILVA",
"filiacao12": "FLAVIO SOARES DA SILVA",
"filiacao31cpf": "83848371472",
"tiposanguineo": "A+",
"dataemissao": "2023-07-26",
"orgaoemissor": "Secretaria de Segurança Pública"
}
}
]
}
}
- uuid (String)
- Campo que contém o uuid do cidadão.Tem o tamanho igual a 36 caracteres.
- 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.
- situacao (Number)
- Campo que contém a situação da identidade digital do cidadão.Tem o tamanho máximo de 11 caracteres.0 - Inativo1 - Ativo2 - Cancelada
- 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.
- 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.
- telefonecidadao (String)
- Campo que contém o telefone do cidadão com CIPTEA.Tem o tamanho de 14 caracteres.
- nomeresponsavel (String)
- Campo que contém o nome do responsável pelo cidadão com CIPTEA.Tem o tamanho de 255 caracteres.
- datavalidade (String)
- Campo que contém a data de validade da carteira de identidade.Tem o tamanho máximo de 10 caracteres.
- nome1abreviado (String)
- Campo que recebe a parte final do nome do cidadão.Tem o tamanho máximo de 37 caracteres.
- naturalidade (String)
- Campo que recebe a naturalidade do cidadão.Tem o tamanho máximo igual a 38 caracteres.
- orgaoexpedidor1 (String)
- Campo que recebe a parte inicial do orgão expedidor do documento.Tem o tamanho máximo de 37 caracteres.
- orgaoexpedidor2 (String)
- Campo que recebe a parte final do orgão expedidor do documento.Tem o tamanho máximo de 37 caracteres.
- localemissao (String)
- Campo que recebe o local emissão do documento.Tem o tamanho máximo de 37 caracteres.
- cidadeemissao (String)
- Campo que recebe a cidade de emissão do documento.Tem o tamanho máximo de 33 caracteres.
- ufemissao (String)
- Campo que recebe a UF da emissão do documento.Tem o tamanho máximo de 2 caracteres.
- flagdeficienciafisica (Boleano)
- Campo que recebe a flag que indica se o cidadão tem deficiência física.Valores possíveis: false e true.false é igual - falsotrue é igual - verdadeiro
- flagdeficienciaauditiva (Boleano)
- Campo que recebe a flag que indica se tem o cidadão possui deficiência auditiva.Valores possíveis: false e true.false é igual - falsotrue é igual - verdadeiro
- flagdeficienciaintelectual (Boleano)
- Campo recebe a flag que indica se o cidadão possui deficiência intelectual.Valores possíveis: false e true.false é igual - falsotrue é igual - verdadeiro
- flagdeficienciavisual (Boleano)
- Campo recebe a flag que indica se o cidadão possui deficiência visual.Valores possíveis: false e true.false é igual - falsotrue é igual - verdadeiro
- flagdeficienciaautismo (Boleano)
- Campo recebe a flag que indica se o cidadão possui autismo.Valores possíveis: false e true.false é igual - falsotrue é igual - verdadeiro
- 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.
- estadoemissao (String)
- Campo que recebe o Estado Emissão.Tem o tamanho máximo de 29 caracteres.
- 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.
- orgaoemissor (String)
- Campo que recebe o Orgão Emissor.Tem o tamanho máximo de 53 caracteres.
- filiacao11abreviada (String)
- Campo que recebe a abreviação do campo filiacao11 do cidadão.Tem o tamanho máximo de 37 caracteres.
- filiacao12abreviada (String)
- Campo que recebe a abreviação do campo filiacao12 do cidadão.Tem o tamanho máximo de 37 caracteres.
- filiacao21abreviada (String)
- Campo que recebe a abreviação do campo filiacao21 do cidadão.Tem o tamanho máximo de 37 caracteres.
- filiacao22abreviada (String)
- Campo que recebe a abreviação do campo filiacao22 do cidadão.Tem o tamanho máximo de 37 caracteres.
- filiacao31abreviada (String)
- Campo que recebe a abreviação do campo filiacao31 do cidadão.Tem o tamanho máximo de 37 caracteres.
- filiacao32abreviada (String)
- Campo que recebe a abreviação do campo filiacao32 do cidadão.Tem o tamanho máximo de 37 caracteres.
- certidaonasccasamento (String)
- Campo que recebe a certidão de nascimento / casamento do cidadão.Tem o tamanho máximo de 120 caracteres.
- cddedo (String)
- Tem o tamanho máximo de 2 caracteres;
- tituloeleitor (String)
- Campo que recebe o título eleitor do cidadão.Tem o tamanho máximo de 14 caracteres.
Recuperar por UUID - Entrada
A API oferece a possibilidade de recuperar os dados do cidadão utilizando um Universally Unique Identifier (UUID). Essa abordagem é recomendada quando se deseja acessar informações específicas associadas a um UUID exclusivo. A Obtenção do UUID pode ser feita por meio da API de Dados Avançados ou por meio da API de CPF. Como entrada temos o UUID do cidadão e como saída temos os dados binários (imagens em base64).
https://api.mj.gov.br/idnacional/{uuid}/imagens
- uuid (String, Obrigatório)
- Campo que recebe o uuid do cidadão.
Recuperar por UUID - Saída
{
"hits": {
"hits": [
{
"_source": {
"versoidentidade": "iVBORw0KGgoAAAANSUhEUgAAAZUAAALQCAYAAABYJu15AACAAElEQVR4Xuy9B7hcV3k1TA....",
"qrcode": "iVBORw0KGgoAAAANSUhEUgAAAZUAAALQCAYAAABYJu15AACAAElEQVR4Xuy9B7hcV3k1TA...",
"polegardireito": "/6D/qAB6TklTVF9DT00gOQpQSVhfV0lEVEggODAwClBJWF9IRUlHSFQgODAwClBJWF9ERVBUSCA4ClBQS....",
"uuid": "17abf6ae-4b3f-4670-ad4f-e63a805f1d6f",
"foto": "iVBORw0KGgoAAAANSUhEUgAAASwAAAGQCAIAAACbF8osAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsM...",
"frenteidentidade": "iVBORw0KGgoAAAANSUhEUgAAAZUAAALQCAYAAABYJu15AACAAElEQVR4Xuy9h7dlV33nWf9Cjw3KOWepFEpVqlIOSEhIICQEyAIMJqe2oc..."
}
}
]
}
}
- uuid (String)
- Campo que contém o uuid do cidadão.
- foto (String)
- Campo base64 que contém a foto de rosto do cidadão.
- qrcode (String)
- Campo base64 que contém o qrcode do cidadão.
- frenteidentidade (String)
- Campo base64 que contém a frente da identidade digital do cidadão.
- versoidentidade (String)
- Campo base64 que contém o verso da identidade digital do cidadão.
- polegardireito (String)
- Campo base64 que contém o polegar direito do cidadão.