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).

.. code-block:: html

   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
++++++++++++++++++++++++


.. code-block:: json
	
	{
		"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"
					}
				}
			]
		}
	}

.. include:: policia-federal-saida-default.rst

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).

.. code-block:: html

   https://api.mj.gov.br/idnacional/pf/cidadaos


.. code-block:: json
	
	{
		"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
+++++++++++++++++++++++++++++++++++++


.. code-block:: json
	
	{
		"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"
					}
				}
			]
		}
	}


.. include:: policia-federal-saida-default.rst

.. include:: uuid.rst