Versão 1.0.1 · RESTful + SOAP
API de Consulta de Status
Consulte em tempo real o status de processos, assinaturas e signatários via API RESTful ou Webservice SOAP.
← Voltar para Desenvolvedores
Introdução
Especificações para integração com o serviço de consulta dos status das assinaturas da GTI Digital, permitindo acompanhar processos, documentos e signatários em tempo real.
Endpoints
Web API – RESTful
Endpoint URL (GET)
Webservice – SOAP
Estrutura da Requisição
| Propriedade | Tipo | Tam. | Obrig. | Descrição |
|---|---|---|---|---|
| apitoken | Texto | 64 | Sim | Token de validação gerado pela GTI Digital. |
| processId | Texto | 36 | Sim | Id do processo retornado pela API de envio de documentos. |
{ "apitoken": "string", "processId": "string" }
Resposta da API
| Propriedade | Tipo | Descrição |
|---|---|---|
| success | Booleano | Indica se o retorno foi bem sucedido. |
| message | Texto | Descrição dos status e/ou erros. |
| processId | Texto | Id do processo. |
| status | Texto | Status do processo. |
| sendDate | Data | Data e hora do envio. |
| completionDate | Data | Data e hora da conclusão. |
| signatures | Inteiro | Quantidade de assinaturas. |
| documents | Lista | Lista de documentos do processo. |
| groups | Lista | Lista de Grupos/Empresas. |
| signers | Lista | Lista de signatários. |
{ "success": true, "message": "string", "process": { "processId": "00000000-0000-0000-0000-000000000000", "status": 0, "sendDate": "2024-01-01T00:00:00.000Z", "signatures": 0, "documents": [ { "filename": "string", "signatures": 0 } ], "groups": [ { "cnpjcpf": "string", "name": "string", "signers": [ { "name": "string", "status": 0, "signatures": 0 } ] } ] } }