Polícia Federal
Esta documentação tem como objetivo fornecer informações detalhadas sobre as APIs disponíveis para Polícia Federal 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": {
"nomeresponsavel": "Carl",
"filiacao12": "FLAVIO SOARES DA SILVA",
"filiacao21": "FLAVIO SOARES DA SILVA",
"versoidentidade": "iVBORw0KGgoAAAANSUhEUgAAAZUAAALQCAYAAABYJu15AACAAElEQVR4Xuy9B7hcV3k1TAotCb2H9tGTUEIIhPIDgUAChA6hBb7Qe7eNqaHXAKGDbdybZFuSLRfZcpNkWV239zt35k7vc3qd9n5rvWfmIl0pxs7...",
"telefonecidadao": "12345678910110",
"datanascimento": "1979-07-06",
"qrcode": "iVBORw0KGgoAAAANSUhEUgAAAtAAAALQCAYAAAC5V0ecAACAAElEQVR4XuydcU5sR7L0x9aT2AMW27iIuwrrs59gFwxYYg9IFmYZ8DxPXoUR3gYye0B6muFTov6jbx3R8TtNdFJ1OkOKf0ac6MjIrDp1x9Kpf7wWCoVCoVAoFAoFjH...",
"filiacao12cpf": "83848371472",
"filiacao31": "FLAVIO SOARES DA SILVA",
"nome2": null,
"cpfresponsavel": "83848371472",
"polegardireito": "/6D/qAB6TklTVF9DT00gOQpQSVhfV0lEVEggODAwClBJWF9IRUlHSFQgODAwClBJWF9ERVBUSCA4ClBQSSA1MDAKTE9TU1kgMQpDT0xPUlNQQUNFIEdSQVkKQ09NUFJFU1NJT04gV1NRCldTUV9CSVRSQVRFIDAuNzUwMDAw...",
"datavalidade": "2033-07-18",
"nomesocial1": "Jessica Aquino",
"filiacao32": "FLAVIO SOARES DA SILVA",
"filiacao22": "FLAVIO SOARES DA SILVA",
"uuid": "17abf6ae-4b3f-4670-ad4f-e63a805f1d6f",
"validadeciptea": "2023-07-18T00:00:00.000Z",
"nome1": "Jessica Aquino",
"filiacao22cpf": "83848371472",
"emailresponsavel": "email@responsavel.com",
"filiacao21cpf": "83848371472",
"enderecoresponsavel": "Groove Street",
"filiacao31cpf": "83848371472",
"filiacao32cpf": "83848371472",
"foto": "iVBORw0KGgoAAAANSUhEUgAAASwAAAGQCAIAAACbF8osAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAP+lSURBVHhe3P2FlyPXve4Pv3",
"tiponacionalidade": "Nato",
"nomesocial2": null,
"telefoneresponsavel": "01101987654321",
"cid": "123456",
"sexo": "F",
"nacionalidade": "BRA",
"situacao": 1,
"frenteidentidade": "iVBORw0KGgoAAAANSUhEUgAAAZUAAALQCAYAAABYJu15AACAAElEQVR4Xuy9h7dlV33nWf9Cjw3KOWepFEpVqlIOSEhIICQEyAIMJqe2oc0s93js5XZ7sE23xx7bGGxwGuzliBcYGiOEVPFVvZxzuu...",
"cpf": "02887318160",
"filiacao11": "FLAVIO SOARES DA SILVA",
"filiacao11cpf": "83848371472",
"dataemissao": "2023-07-18",
"enderecocidadao": "Blablabla"
}
}
]
}
}
- 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.
- 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": "Holly Richmond",
"filiacao2": "Richard Richmond",
"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": {
"nomeresponsavel": "Carl",
"filiacao12": "FLAVIO SOARES DA SILVA",
"filiacao21": "FLAVIO SOARES DA SILVA",
"telefonecidadao": "12345678910110",
"datanascimento": "1979-07-06",
"filiacao12cpf": "83848371472",
"filiacao31": "FLAVIO SOARES DA SILVA",
"nome2": null,
"cpfresponsavel": "83848371472",
"datavalidade": "2033-07-18",
"nomesocial1": "Jessica Aquino",
"filiacao32": "FLAVIO SOARES DA SILVA",
"filiacao22": "FLAVIO SOARES DA SILVA",
"uuid": "17abf6ae-4b3f-4670-ad4f-e63a805f1d6f",
"validadeciptea": "2023-07-18T00:00:00.000Z",
"nome1": "Jessica Aquino",
"filiacao22cpf": "83848371472",
"emailresponsavel": "email@responsavel.com",
"filiacao21cpf": "83848371472",
"enderecoresponsavel": "Groove Street",
"filiacao31cpf": "83848371472",
"filiacao32cpf": "83848371472",
"tiponacionalidade": "Nato",
"nomesocial2": null,
"telefoneresponsavel": "01101987654321",
"cid": "123456",
"sexo": "F",
"nacionalidade": "BRA",
"situacao": 1,
"cpf": "02887318160",
"filiacao11": "FLAVIO SOARES DA SILVA",
"filiacao11cpf": "83848371472",
"dataemissao": "2023-07-18",
"enderecocidadao": "Blablabla"
}
}
]
}
}
- 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.
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.