← Voltar para Desenvolvedores
Introdução
Define as especificações para integração entre o serviço de assinaturas da plataforma GTI Digital e qualquer sistema que possibilite o consumo de Web APIs baseados em HTTP (RESTful). Permite automatizar o processo de assinatura eletrônica para documentos e operações.
Estrutura da Requisição
| Propriedade | Tipo | Tam. | Obrig. | Descrição |
|---|
| apitoken | Texto | 64 | Sim | Token de validação gerado pela GTI Digital. |
| user | Texto | 150 | Sim | E-mail do usuário da conta na plataforma. |
| id | Texto | 64 | Sim | Código alfanumérico de identificação da operação. |
| title | Texto | 64 | Sim | Identificação da finalidade do processo. |
| description | Texto | 2048 | Sim | Descrição da finalidade do processo. |
| notify | Booleano | — | Sim | Define se os signatários serão notificados por e-mail. |
| signers | Lista | — | Sim | Lista de Signatários. |
| name | Texto | 150 | Sim | Nome do signatário. |
| cpf | Texto | 18 | Sim | CPF/CNPJ do signatário. |
| email | Texto | 150 | Sim | E-mail do signatário. |
| function | Perfis | — | Sim | Perfil do signatário. Ver Lista de Perfis. |
| sign | Booleano | — | Sim | Define se o signatário assinará os documentos. |
| certificate | Booleano | — | Sim | Define se o uso de certificados é obrigatório. |
| documents[].filename | Texto | 150 | Sim | Nome do documento. |
| documents[].content | Base64 | — | Sim | Conteúdo do documento em Base64. |
| documents[].signable | Booleano | — | Sim | Define se o documento é assinável. |
JSON de Requisição
{
"apitoken": "string",
"user": "string",
"id": "string",
"title": "string",
"description": "string",
"notify": true,
"signers": [
{ "name": "string", "cpf": "string", "email": "string", "function": 0, "sign": true, "certificate": true }
],
"groups": [
{ "cnpjcpf": "string", "name": "string", "signers": [ { "name": "string", "cpf": "string", "email": "string", "function": 0, "sign": true, "certificate": true } ] }
],
"documents": [
{ "content": "string", "signable": true, "filename": "string" }
]
}
Lista de Perfis
| Perfil | Chave |
|---|
| Colaborador | 0 |
| Representante | 1 |
| Fiador/Avalista | 2 |
| Responsável Solidário | 3 |
| Procurador | 4 |
| Presidente | 6 |
| Diretor | 7 |
| Devedor Solidário | 8 |
| Testemunha | 10 |
| Sócio | 11 |
| Avalista | 13 |
| Emitente | 15 |
| Administrador | 16 |
| Gestor | 41 |
| Convidado | 42 |
| Validador | 43 |
| Representante Legal | 44 |
| Investidor | 96 |
| Advogado | 97 |
| Contador | 98 |
| Outro | 99 |
Resposta da API
| Propriedade | Tipo | Descrição |
|---|
| success | Booleano | Indica se o retorno foi bem sucedido. |
| message | Texto | Descrição dos erros. |
| processId | Guid | Id do processo criado na plataforma GTI Digital. |
{ "success": true, "message": "string", "processId": "string" }
| Mensagem | Sucesso |
|---|
| Sucesso - documentos enviados com sucesso. | true |
| Falha - Usuário ou API Token inválido. | false |
| Falha - Dados do processo enviados incorretamente. | false |
| Falha - E-mail inválido para o signatário. | false |