# Endpoints de Integração SSP/DETRAN

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

Todos os endpoints devem conter token fixo no header

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

Ordem a ser seguida: Dados biográficos,Upload de documentos, deca, foto e por ultimo assinatura.

### ==**POST** - /Solicitacao/AdicionarRequerenteDetran==

###### Endpoint utilizado para adicionar os dados biográficos do requerente enviado pelo Detran. Dado de renach é obrigatório independente se tiver ou não os demais dados da CNH.

**Foi adicionada a propriedade flagPassivo para identificar registros passivos. Caso essa propriedade não seja enviada ou não receba valor, o registro será tratado como diário por padrão. Para indicar um registro como passivo, é necessário enviar a propriedade com o valor true.**

[url]/Solicitacao/AdicionarRequerenteDetran

{    
    "observacao" : "qualquer observação",
    "flagPassivo":"true",
    "filiacao" : 
    {
        "nome" : "Teste Status PROCESSO DETRAN GLEICE DAIANA 3",
        "nomePai" : "Teste Status PROCESSO DETRAN PAI",
        "nomeMae" : "Teste Status PROCESSO DETRAN MAE",
        "NomeConjuge" :"Teste Nome Conjuge",
        "nomesocial": "TESTE NOME INTEGRAÇÃO OFFLINE NOME SOCIAL"     
    },
    "telefones" : 
    [
        {   
            "ddd" : 62,
            "numero" : "989898989"
        },
        {
            "ddd" : 61,
            "numero" : "77777777"
        }
    ],
    "outrosdocumentos" : 
    {
        "cpf" : "765.483.670-81",   
        "NumeroCTPS" :"1",
        "SerieCTPS" :"1",
        "UFCTPS" :"GO"
    },
    "RGOutroEstado":
    {
        "numero" : "4565878",
        "dataexpedicao" : "2021-01-01",
        "orgaoexpedidor" : "SSP",
        "ufexpedidor" : "SP",
        "tipodocumentoapresentado": 6 
    },
    "cnh" : 
    {
        "renach":"GO116424044",
        "numero" : "646498999",
        "dataexpedicao" : "2021-01-01",
        "categoria" : "AB" ,     
        "DtAberturaProcesso": "2021-01-01",
        "DtColetaBiometrica": "2021-01-01",
        "DescMunicipioOrigem":"Aparecida de Goiânia",
        "DescUnidadeOrigem":"Buriti Shopping"
    },
    "estadocivil" : 
    {
        "tipo" : 1 //Solteiro
    },
    "pessoasexo" : 
    {
        "tipo" : 3 //Feminino
    },
    "endereco" :
    {
        "municipio" : "Goiânia",
        "bairro" : "Centro",
        "cep" : "74000000",
        "logradouro" : "Av. Goiás - Sala 548",
        "numero" : 555,
        "complemento" : null,
        "DescPais":"Brasil",
        "Sigla":"GO",
        "DescMunicipio":"Goiânia"
    },
    "nascimento" : 
    {
        "data" : "1974-01-20",
        "pais" : "Brasil",
        "Sigla":"GO",
        "DescMunicipio":"Goiânia"
    },
    "email" : 
    {
        "endereco" : "[e-mail]"
    }   ,
    "condicoesespeciais" : 
	[
		{
			"codigo" : "1" //Fisica ou acesso
		}
	]
}

### ==**POST** - /BiometriaCivilDigital/AdicionarPorProtocoloId==

###### Endpoint utilizado para adicionar biometrias do requerente. Deve ser passado no query param (protocoloId) e no form-data, deverão ser passadas as biometrias 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/AdicionarPorProtocoloId?protocoloId=5691529

{"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/AdicionarPorProtocoloId==

###### Endpoint utilizado para adicionar foto, passando por query param o protocoloId. No form-data deverá ser passada a foto.

[url]/BiometriaCivilFoto/AdicionarPorProtocoloId?protocoloId=5691529

### ==**POST** - /BiometriaCivilAssinatura/AdicionarPorProtocoloId==

###### Endpoint utilizado para adicionar assinatura, passando por query param o protocoloId. No form-data deverá ser passada a foto.

[url]/BiometriaCivilAssinatura/AdicionarPorProtocoloId?protocoloId=5691529

### ==**POST** - /ArquivoCivil/AdicionarPorProtocoloIdExterno==

###### Endpoint utilizado para adicionar upload dos documentos do requerente. Deve ser inserido no query parâmetro (protocoloId, tipoArquivo) e no form-data, deverá ser passado o documento digitalizado e a chave com o tipo. Extensões aceitas são png, pdf e jpg.

[url]/ArquivoCivil/AdicionarPorProtocoloIdExterno?protocoloId=5691733&empresaResponsavel=3

**Exemplo:**

### ==**POST** - /ArquivoCivil/ExcluirPorProtocoloIdExterno==

###### Endpoint utilizado para excluir um ou mais documentos do requerente. Deve ser passado no query parâmetro (protocoloId,empresaResponsavel e tipoArquivo). Lembrando que se tiver mais de um documento por tipo, todos serão excluídos.

[url]/ArquivoCivil/ExcluirPorProtocoloIdExterno?empresaResponsavel=3&tiposArquivo[]=5&protocoloId=5724533

### ==**GET** - Rg/ObterPorRequerenteDetran==

###### Endpoint utilizado para consultar dados biometricos de uma pessoa, caso exista os mesmos serão retornados. Dados: Foto, Assinatura e a deca cadastrada.
- **Confirmar (Detran e SIH): Só será retornado registros que esteja finalizado no WF e tenha passado pelo AFIS, requerentes que não teve biometria valida não esta retornando.**

[url]/Rg/ObterPorRequerenteDetran?nome=LARISSA ROCHA LIRA&nomeMae=GEANE DA SILVA ROCHA MATOS&nomePai=DIOGO LIRA MATOS&dataNascimento=2011-06-17&rg=7000077&cpf=70917163109

### ==**GET** - Rg/ObterPorCPFRequerenteDetran==

###### Endpoint utilizado para consultar dados biometricos de uma pessoa, utilizando informando apenas o cpf, caso exista os mesmos serão retornados. Dados biograficos basicos, Foto, Assinatura e a deca cadastrada.

- **Confirmar (Detran e SIH): Só será retornado registros que esteja finalizado no WF e tenha passado pelo AFIS, requerentes que não teve biometria valida não esta retornando.**

[url]/Rg/ObterPorCPFRequerenteDetran?cpf=00000890103

### ==**GET** - Transacao/ObterStatusPorProtocoloId?protocoloid=5669258==

### ==**GET** - Transacao/ObterStatusPorRenach?renach=GO157109658==

###### Endpoint para consultar status de um determinado protocolo ou renach para casos de solicitações do tipo detran, podendo ser:
###### 5 - O protocolo esta em preenchimento, faltando dados biometricos (digital,foto e/ou assinatura).
###### 15 - O protocolo esta em preenchimento, faltando upload de documentos.
###### 16 - O protocolo esta em preenchimento, faltando a decatilar.
###### 17 - O protocolo esta em preenchimento, faltando foto.
###### 18 - O protocolo esta em preenchimento, faltando assiantura.
###### 1 ou 8 - O protocolo foi transacionado e está ativo.
###### 7 - O protocolo está em perito para análise de decisão.
###### 0 - O protocolo informado, foi gravado com sucesso, mais não foi transacionado ainda.
###### 11 - O protocolo bloqueado.
###### -1 - Nenhuma solicitação encontrada com os dados informados.

[url]/Transacao/ObterStatusPorProtocoloId?protocoloid=5669258

OU

[url]/Transacao/ObterStatusPorRenach?renach=GO157109658

### ==**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

- **Tipo de arquivo - No Upload de Documentos apresentados:**
1 - Certidão Nascimento
3 - Endereço
4 - CPF
5 - Outros

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

- **Anomalia:**
11 - Amputado
12 - Danificado
13 - Enfaixado
19 - Interno
21 - Alergia
22 - Amputação Parcial
23 - Cicatriz
24 - Atrofiado
25 - Bebê

- **Condições Especiais:**
1 - Física / Acesso
2 - Auditiva / Libras
3 - Visual / Cegueira
4 - Intelectual / Mental
5 - Autismo
6 - Síndrome de Down

- **Tipo de Certidão:**
1 - Certidão de Nascimento
2 - Certidão de Casamento
3 - Certidão de Casamento C/Av. de Separação Judicial
4 - CERTIFICADO DE NATURALIZAÇÃO
5 - Certidão de Igualdade
6 - Certidão de Óbito
7 - CARTEIRA DE IDENTIDADE DO ESTADO DE GÓIAS
8 - Certidão de Casamento com Averbação de Divórcio
9 - CERTIFICADO DE NATURALIZAÇÃO PROVISÓRIA

- **Tipo documento Apresentado:** Que pode ser enviado no conjunto de dados do RGOutroEstado.
1 - Carteira Profissional
5 - RG Militar
6 - RG Outro Estado RG\CIN de Goiás
10 - Carteira OAB
Para Carteira de trabalho por ter mais informações enviar dados no conjunto outrosdocumentos.

- **Empresa Responsável ou CodigoRespColetaBiometrica:**
1 - Policia Civil
2 - Montreal
3 - Detran
4 - NatoSafe
5 - Akiyama

- **Estado Civil:**
1 - Solteiro(a)
2 - Casado(a)
3 - Viúvo(a)
5 - Divorciado(a)
9 - Separado(a)