# Endpoints de Integração SSP/NatoSafe

### Urls
Homologação - https://api-hgoiasbiometrico.ssp.go.gov.br
Produção - https://apigoiasbiometrico.ssp.go.gov.br

Para todos os endpoints deve ter Token Fixo no Header

Token Homologação - 021abe7c292bbbc5348cf7dd91168be8
Token Produção - ********************************

### ==**GET** - /Solicitacao/ObterPorNumeroDNV==

###### Endpoint para obter o cadastro civil, por um número de DNV, através de query params.

[url]/Solicitacao/ObterPorNumeroDNV?numDNV=21-00000000-4

### ==**POST** - /Solicitacao/AdicionarRequerenteNatoSafe==

###### Endpoint para adicionar uma solicitação de um recém-nascido vindo da nato safe.

{		
	"declaracaonascidovivo": 
	{
	"numdnv": "21-00000000-6",
	"hora": "08:31",
	"peso": "2500",
        "data" : "2021-01-20",
        "altura": "48",
        "DocumentosIdentificacaoMae" : 
            [
                {   
                    "Tipo": 1,
                    "Numero": "5569914",
                    "DataEmissao":"2009-01-20",
                    "UFEmissor": "GO",
                    "OrgaoEmissor": "SSPGO"
                },
                {
                    "Tipo": 3,
                    "Numero": "5569914",
                    "DataEmissao":"2009-01-20",
                    "UFEmissor": "GO",
                    "OrgaoEmissor": "SSPGO"
                }
            ] 
	},
	"filiacao" : {
		 "nome" : "Nome Teste arquivo NatoSafe4",
		 "nomePai" : "Nome da Pai Teste arquivo NatoSafe4",
		 "nomeMae" : "Nome da Mae Teste arquivo NatoSafe4",
                "FlagNaoInformadoNomePai":"false", //true se não informar o nome do pai
		 "FlagNaoInformadoNomeMae":"false"//true se não informar o nome da mãe
	},	
	"telefones" : //Não é obrigatório
	[
		{   
			"ddd" : 62,
			"numero" : "85858514"
		},
		{
			"ddd" : 61,
			"numero" : "77772114"
		}
	],
	"outrosdocumentos" : {
		"cpf" : "323.468.340-92"
	},    
	"pessoasexo" : {
		"tipo" : 2 //Feminino
	},
	"endereco" :{
               "sigla": "Go",
		"descmunicipio" : "Goiânia",
		"bairro" : "Centro",
		"cep" : "74565-214",
		"logradouro" : "Logradouro Endereço Mae Teste arquivo NatoSafe4",
		"numero" : 514,
		"complemento" : "Complemento Endereço Mae Teste arquivo NatoSafe4"
	},
	"nascimento" : {
		"data" : "2021-01-20",
		"pais" : "Brasil",
		"sigla" : "GO",
		"descmunicipio" : "Goiânia",
		"observacao" : "Teste arquivo NatoSafe observação nascimento3"
	},
	"email" :{
		"endereco" : "[e-mail]"
	}, 
	"certidao": {
		"TipoId":"1",
		"Original":"true",
		"Cartorio":"Cartorio Teste arquivo NatoSafe4",
		"Livro":"Livro15",
		"Pagina": "15",
		"Numero": 15,
		"Observacao":"Observacao certidao Teste arquivo NatoSafe4",
		"DataEmissao":"2021-01-20",    
		"Portaria":15,     
		"Sigla":"GO",
		"DescMunicipio":"Trindade"		
	},	
	"condicoesespeciais" : 
	[
		{
			"codigo" : "1" //Fisica ou acesso
		}
	]	

}	

### ==**POST** - /Certidao/AdicionarPorNumDNV==

###### Endpoint para adicionar a uma solicitação os dados da certidão de nascimento. Pois essa pode ser informada junto com o a solicitação ou posteriormente, dependendo da configuração.

{
    "TipoId":"1",
    "Original":"true",
    "Cartorio":"Cartorio Teste 02",
    "Livro":"Livro02",
    "Pagina": "10",
    "Numero": 54,
    "Observacao":"Observacao certidao 2",
    "DataEmissao":"2020-11-20",    
    "Portaria":11,     
    "Sigla":"GO",
    "DescMunicipio":"Trindade",
    "NumDNV":"21-00000000-6"    
}

### ==**POST** - /BiometriaCivilDigital/AdicionarWSQPorProtocoloIdDnv==

###### Endpoint para adicionar biometrias do recém-nascido. Deve ser passado no query param (protocoloId, número do DNV) e no form-data deverão ser passadas as biométrias em WSQ, onde cada chave corresponde ao identificador da digital. Também no form-data deverá ser passado um objeto INFO, enviando a qualidade NFIQ das digitais.

[url]/BiometriaCivilDigital/AdicionarWSQPorProtocoloIdDnv?numDnv=21-00000000-2&protocoloId=5669952

{"qualidade" : 
    [
        {"subgrupo" : 6, "nfiq" : 3, "anomalia":11},
        {"subgrupo" : 7, "nfiq" : 2},
        {"subgrupo" : 8, "nfiq" : 1},
        {"subgrupo" : 9, "nfiq" : 4},
        {"subgrupo" : 10, "nfiq" : 3},
        {"subgrupo" : 11, "nfiq" : 3},
        {"subgrupo" : 12, "nfiq" : 5},
        {"subgrupo" : 13, "nfiq" : 3},
        {"subgrupo" : 14, "nfiq" : 3},
        {"subgrupo" : 15, "nfiq" : 3},
    ]
}

### ==**POST** - /BiometriaCivilFoto/AdicionarPorProtocoloIdDnv==

###### Endpoint para adicionar foto passando por query param o protocoloId e número de dnv. No form-data deverá ser passada a foto.

[url]/BiometriaCivilFoto/AdicionarPorProtocoloIdDnv?numDnv=21-00000000-4&protocolo=5669958

### ==**POST** - /BiometriaCivilPalmar/AdicionarWSQPorProtocoloIdDnv==

###### Endpoint para adicionar palmares do recém-nascido. Deve ser passado no query param (protocoloId, número do DNV e info) e no form-data deverão ser passadas os palmares em WSQ, onde cada chave corresponde ao identificador da palmar. Também no form-data deverá ser passado um objeto INFO, enviando a qualidade NFIQ das palmares.

[url]/BiometriaCivilPalmar/AdicionarWSQPorProtocoloIdDnv?numDnv=21-00000000-4&protocoloId=5669958&info={"qualidade" : 
    [
        {"subgrupo" : 2, "nfiq" : 3},
        {"subgrupo" : 3, "nfiq" : 2},       
    ]
}

### ==**POST** - /BiometriaCivilPlantar/AdicionarWSQPorProtocoloIdDnv==

###### Endpoint para adicionar plantar do recém-nascido. Deve ser passado no query param (protocoloId, número do DNV e info) e no form-data deverão ser passadas os plantares em WSQ, onde cada chave corresponde ao identificador da plantar. O objeto info deve enviar a qualidade NFIQ das plantares.

[url]/BiometriaCivilPlantar/AdicionarWSQPorProtocoloIdDnv?numDnv=21-00000000-4&protocoloId=5669958&info={"qualidade" : 
    [
        {"subgrupo" : 602, "nfiq" : 3},
        {"subgrupo" : 603, "nfiq" : 2},       
    ]
}

### ==**POST** - /ArquivoCivil/AdicionarPorProtocoloIdDnv==

###### Endpoint para adicionar os anexos dos tipos: 13 para deca, 14 para a palmar, 15 para plantar da criança e 17 para deca da mãe em jpeg, cujo tamanho arquivo será full, assim como outros tipos de anexos, tais como 1 para certidão de nascimento e 5 para outros tipo,como por exemplo comprovante de endereço.

###### Deve ser passado no query param (protocoloId, número do DNV , tipoArquivo e se esta finalizado) e no form-data deverão ser passados os anexos em jpeg, onde cada chave corresponde ao identificador.

[url]/ArquivoCivil/AdicionarPorProtocoloIdDnv?numDnv=31-0000300-1&protocoloId=5670508&finalizarAnexos=false&tipoArquivo=1

### ==**Identificadores**==

- **Digitais:**
6 - Polegar Esquerdo
7 - Indicador Esquerdo
8 - Médio Esquerdo
9 - Anelar Esquerdo
10 - Mínimo Esquerdo
11 - Polegar Direito
12 - Indicador Direito
13 - Médio Direito
14 - Anelar Direito
15 - Mínimo Direito

- **Palmares:**
2 - Palmar Esquerdo
3 - Palmar Direito

- **Plantares:**
602 - Plantar Esquerdo
603 - Plantar Direito

- **Tipo Arquivo:**
1 - Certidão Nascimento
3 - Endereço
4 - CPF
5 - Outros
13 - DecatilarFull
14 - PalmarFull
15 - PlantarFull
16 - DnvDocumento
17 - DecatilarMae
18 - DecatilarMaeWSQ

- **Sexo:**
1 - Indefinido
2 - Masculino
3 - Feminino

- **Anomalia:**
11 - Amputado
25 - Bebe

- **Tipo Documento Identificação Mãe:**
1 - RG
2 - CPF
3 - CNH
4 - Passaporte