---
# System prepended metadata

title: Endpoints de Integração SSP/Montreal

---

# Endpoints de Integração SSP/Órgão externo(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: Confirmar a coleta, adicionar os dados biométricos, iniciando pela digital, foto e por último a assinatura, após deve ser adicionado os documentos digitalizados.
Quando não houver mais nada a ser enviado, deve ser finalizada a coleta.


### ==**POST** - /Solicitacao/ConfirmarColetaBiometrica==

###### Endpoint utilizado para confirmar a coleta, que será feita por uma empresa terceirizada: 
###### Segue abaixo os conjuntos de dados obrigatórios:
###### 1 - Protocolo e CPF
###### 2 - Protocolo, Nome, Nome da Mãe e Data de Nascimento.

```
[url]/Solicitacao/ConfirmarColetaBiometrica
```
```json=
{
    "ProtocoloId":"5691742",   
    "Nome":"FLAVIA CRISTIANA VELOZO FERRANTE",
    "NomeMae":"MARTA ALVES VELOZO",
    "Data":"05/04/1986",
    "CodigoRespColetaBiometrica":"2"
}
```
###### O retorno será:
###### Protocolo apto a coleta biométrica.
###### Os dados informados não estão aptos a coleta, ou dados não encontrados.

### ==**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=2&tipoArquivo=3
```
**Exemplo:**
![](https://i.imgur.com/PYYrKE1.png)

### ==**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?protocoloId=5691733&empresaResponsavel=2&tiposArquivo[]=1, 3
```

### ==**POST** - /BiometriaCivilDigital/AdicionarPorProtocoloIdExterno==

###### Endpoint utilizado para adicionar biometrias do requerente. Deve ser passado no query o parâmetro (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/AdicionarPorProtocoloIdExterno?protocoloId=5691733&empresaResponsavel=2
```
```
{"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},
    ]
}
```
**Exemplo:**
![](https://i.imgur.com/ByNTrar.png)


### ==**POST** - /BiometriaCivilFoto/AdicionarPorProtocoloIdExterno==

###### Endpoint utilizado para adicionar foto. Passando por uma query o parâmetro protocoloId. No form-data deverá ser passada a foto.

```
[url]/BiometriaCivilFoto/AdicionarPorProtocoloIdExterno?protocoloId=5691529&empresaResponsavel=2
```

### ==**POST** - /BiometriaCivilAssinatura/AdicionarPorProtocoloIdExterno==

###### Endpoint utilizado para adicionar assinatura, informando o no query o parâmetro protocoloId e empresa responsável. No form-data deverá ser passada a foto. Caso o requerente não seja alfabetizado, adicionar no parâmetro obsNaoAlfabetizado. Caso seja impossibilitado, informar no parâmetro obsImpossibilitadoAssinar.


```
[url]/BiometriaCivilAssinatura/AdicionarPorProtocoloIdExterno?protocoloId=5691529&empresaResponsavel=2
```
```
[url]/BiometriaCivilAssinatura/AdicionarPorProtocoloIdExterno?protocoloId=5691529&empresaResponsavel=2&obsNaoAlfabetizado=criança
```
```
[url]/BiometriaCivilAssinatura/AdicionarPorProtocoloIdExterno?protocoloId=5691529&empresaResponsavel=2&obsImpossibilitadoAssinar=Mão direita quebrada
```

### ==**POST** - /Solicitacao/FinalizarColetaBiometrica==

###### Endpoint utilizado para finalizar o envio dos dados biométricos e envio dos documentos. Deve ser passado no query parâmetro (protocoloId, empresaResponsavel).
Em homologação esta configurado como obrigatório(certidao,endereço e cpf)

```
[url]/Solicitacao/FinalizarColetaBiometrica?protocoloId=5691529&empresaResponsavel=2
```

### ==**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 Arquivo:** 
 ### ==***Alterado Codigo foi alterado de 1 para 7**==
 7 - Certidão Nascimento, Casamento entre outras - Obrigatório  
 3 - Endereço - Obrigatório
 4 - CPF - Obrigatório
 5 - Outros

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

- **Empresa Responsável ou CodigoRespColetaBiometrica:**
2 - Montreal