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

Estrutura da Requisição

PropriedadeTipoTam.Obrig.Descrição
apitokenTexto64SimToken de validação gerado pela GTI Digital.
processIdTexto36SimId do processo retornado pela API de envio de documentos.
{ "apitoken": "string", "processId": "string" }

Resposta da API

PropriedadeTipoDescrição
successBooleanoIndica se o retorno foi bem sucedido.
messageTextoDescrição dos status e/ou erros.
processIdTextoId do processo.
statusTextoStatus do processo.
sendDateDataData e hora do envio.
completionDateDataData e hora da conclusão.
signaturesInteiroQuantidade de assinaturas.
documentsListaLista de documentos do processo.
groupsListaLista de Grupos/Empresas.
signersListaLista 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 } ] } ] } }