---
# System prepended metadata

title: Endpoints de Integração SSP/Akiyama offline

---

# Endpoints de Integração SSP/Akiyama offline
### 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**:==
###### Para 1ª vias
1 - Adicionar dados biografico;
2 - Adicionar os dados biométricos; 
 2.1 - Digital;
 2.2 - Foto;
 2.3 - Assinatura;
3 - Documentos digitalizados.
4 - Quando não houver mais nada a ser enviado, deve ser finalizada a coleta.

###### Para 2ª vias
1 - Adicionar dados biografico;
2 - Adicionar dados de pagamentos;
3 - Adicionar os dados biométricos; 
 3.1 - Digital;
 3.2 - Foto;
 3.3 - Assinatura;
4 - Documentos digitalizados.
5 - Quando não houver mais nada a ser enviado, deve ser finalizada a coleta.

### ==**POST** - /Solicitacao/AdicionarRequerenteExterno==

###### Endpoint utilizado para adicionar os dados biográficos do requerente enviado pela akiyama, do software que realizará a coleta offline.
Quando tratar de 1ª via, remova a propriedade rgnumero .

```
[url]/Solicitacao/AdicionarRequerente
```

```json=
{
    "empresaresponsavel": "5",
    "origemid":"2",
    "tipoid": "2",
    "observacao": "TESTE OFF",        
    "flagdoadororgao": 0, 
    "tiposanguineo": "O RH-",
    "tipomaterialimpresso": "1",
    "rgnumero":"4565878",
    "buscadeRG":0,    
	 "estadocivil" : 
    {
        "tipo" : 1 //Solteiro
    },
    "instrucao": {
        "id": 2
    },  
    "filiacao": {
        "nome": "TESTE NOME INTEGRAÇÃO OFFLINE 3",
        "nomepai": "TESTE NOME INTEGRAÇÃO OFFLINE PAI 3",
        "nomemae": "TESTE NOME INTEGRAÇÃO OFFLINE MAE 3",
        "nomeconjuge": "TESTE NOME INTEGRAÇÃO OFFLINE CONJUGE 3", 
        "flagnaoinformadonomepai": 0,
        "flagnaoinformadonomemae": 0,
        "flagoutrospais": 0,
        "nomepaioutro": "",
        "nomemaeoutro": "",       
        "nomesocial": "TESTE NOME INTEGRAÇÃO OFFLINE NOME SOCIAL"       
    },
    "nascimento": {       
        "data": "1949-05-05",
        "pais": "Brasil",                       
        "observacao": "Observação teste",       
        "sigla": "GO",
        "descmunicipio": "Goiânia"
    },
    "certidao": {       
        "tipoid": "1",
        "original": 1,
        "cartorio": "2 zn",
        "livro": "A-563",
        "pagina": "59",
        "numero": "110699",
        "observacao": "Teste Certidão Observação",
        "dataemissao": "1984-10-04",        
        "folhadou": "",
        "portaria": "",
        "sigla": "GO",
        "descmunicipio": "Goiania"
        
    },
    "endereco": {            
        "bairro": "Central",
        "cep": "74000-000",
        "logradouro": "rua a",
        "numero": "123",
        "complemento": "teste complemento",
        "sigla": "GO",
        "descmunicipio": "Goiania",
        "observacao": "TESTE observacao",
        "descpais": "Brasil"      
    },
    "pessoasexo": {       
        "tipo": 3
    },
    "outrosdocumentos": {
        "numeropis": "525.00640.37-0",
        "cpf": "067.098.690-91",       
        "nis": "",
        "dni": "",
        "cartaonacionalsaude": "",
        "numeroctps": "6300251015",
        "seriectps": "95432",
        "ufctps": "GO",
        "nit": ""
    },
    "cnh": {        
        "renach":"GO123123198",
        "numero" : "123123189",
        "dataexpedicao" : "2022-10-31,",
        "categoria" : "AB"
    },
    "condicoesespeciais": 
	[       
		{            
            "codigo": ""
        }
    ],
    "email": {        
        "endereco": "testedetran@teste.com" 
    },
	"rgoutroestado": {
        "numero" : "194979",
        "dataexpedicao" : "2013-11-13",
        "orgaoexpedidor" : "SSP",
        "ufexpedidor" : "SP"
    },
    "telefones": [
        {
            "ddi": 555,
            "ddd": 62,
            "numero": "9942-80898"
        }
    ],    
    "observacoesdesaude": [
        {
            "codigo": ""
        }
    ]   
}

```

### ==**POST** - /SolicitacaoPagamento/Adicionar==

###### Endpoint utilizado para adicionar os dados de pagamento, para uma solicitação de segunda via do requerente deve ser enviado pela akiyama, do software que realizará a coleta offline.


```
[url]/SolicitacaoPagamento/Adicionar
```
```json=
{   
    "ProtocoloId": 5694602,
    "Isencao": 0,
    "MotivoIsencaoId": null,
    "Banco": "CAIXA ECONOMICA",
    "ValorPago": "35,90",
    "DataPagto": "2022-01-19",
    "CodReservado": null,
    "CodBarras": null,
    "Observacoes": "OFFLINE",    
    "NumDare": "12602542204201162",
    "AutenticacaoBancaria": null,
    "MotivoIsencao": null,
	"EmpresaResponsavel":5
}
```

### ==**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=5&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/AdicionarPorProtocoloIdExterno??protocoloId=5691733&empresaResponsavel=5&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=5
```
```
{"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=5
```

### ==**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=5
```
```
[url]/BiometriaCivilAssinatura/AdicionarPorProtocoloIdExterno?protocoloId=5691529&empresaResponsavel=5&obsNaoAlfabetizado=criança
```
```
[url]/BiometriaCivilAssinatura/AdicionarPorProtocoloIdExterno?protocoloId=5691529&empresaResponsavel=5&obsImpossibilitadoAssinar=Mão direita quebrada
```

### ==**POST** - /Solicitacao/FinalizarColeta==

###### Endpoint utilizado para finalizar o envio dos dados biométricos e envio dos documentos. Deve ser passado no query parâmetro (protocoloId, CodigoRespColetaBiometrica).

```
[url]/Solicitacao/FinalizarColeta?protocoloId=5691529&CodigoRespColetaBiometrica=5
```

### ==**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:**
 1 - Certidão Nascimento - Obrigatório
 3 - Endereço - Obrigatório
 4 - CPF 
 5 - Outros

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

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

- **Estado Civil:**
1 - Solteiro(A)
2 - Casado(A)
3 - Viuvo(A)
4 - Desquitado(A)
5 - Divorciado(A)
7 - Outro
8 - União Estável
9 - Separado(A) Judicialmente
10 - Não Informado

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

- **Empresa Responsável:**
5 - Akiyama

- **OrigemId:**
2 - ImportacaoOffline


- **Tipo Id:**
1 - Primeira Via
2 - Segunda Via

- **Tipo Material Impresso:**
1 - CIE Papel
2 - CIN Papel
3 - CIN Cartão

- **Tipo Sanguíneo**
A RH+
A RH-
AB RH+
AB RH-
B RH+
B RH-
O RH+
O RH-

- **Observação Saúde**
http://www2.datasus.gov.br/cid10/V2008/cid10.htm

- **COD UF**
12 - AC
27 - AL
13 - AM
16 - AP
29 - BA
23 - CE
53 - DF
32 - ES
52 - GO
21 - MA
31 - MG
50 - MS
51 - MT
15 - PA
25 - PB
26 - PE
22 - PI
41 - PR
33 - RJ
24 - RN
11 - RO
14 - RR
43 - RS
42 - SC
28 - SE
35 - SP
17 - TO

- **Instrução**
1 - NÃO-ALFABETIZADO
2 - FUNDAMENTAL INCOMPLETO
3 - FUNDAMENTAL COMPLETO
4 - MÉDIO INCOMPLETO
5 - MÉDIO COMPLETO
6 - SUPERIOR INCOMPLETO
7 - SUPERIOR COMPLETO
8 - ESPECIALIZAÇÃO
9 - MESTRADO
10 - DOUTORADO
11 - NÃO INFORMADO
12 - PÓS-DOUTORADO

- **Motivo Isenção de Pagamentos**
1 - PROGRAMA SOCIAL
2 - CARÊNCIA FINANCEIRA
3 - ATESTADO DE BONS ANTECEDENTES
4 - CERTIDÃO DE REGISTRO GERAL
5 - CONSERTO

### ==** Regras iniciais**==
- **Existe regras a serem alinhado referente a estado civil e dados de certidão. Ex: Um solteiro não pode apresentar uma certidão de casamento ou de divorcio.**
- **Se os dados básicos (Filiação, Nascimento), já existir na base e o dado for valido  será 2ª via, caso contrario 1ª via.**
- **Porem no caso do usuário possuir um RG este deve ser informado pois pode ser uma 2ª via busca.**
