Historico de Atividades

Retorna a trilha de auditoria completa de um envelope, com todos os eventos registrados desde a criacao ate a conclusao (ou cancelamento).

Requisicao

GET /v1/envelopes/{id}/audit

Headers

Header	Tipo	Obrigatorio	Descricao
Authorization	string	Sim	Bearer token de autenticacao

Parametros de URL

Parametro	Tipo	Obrigatorio	Descricao
id	string	Sim	Identificador unico do envelope

Exemplo de requisicao

curl -X GET \
  https://api.tapsign.com.br/v1/envelopes/env_d4e5f6a7-8b9c-0d1e-2f3a-4b5c6d7e8f9a/audit \
  -H "Authorization: Bearer {token}"

Resposta

200 - Sucesso

{
  "envelopeId": "env_d4e5f6a7-8b9c-0d1e-2f3a-4b5c6d7e8f9a",
  "events": [
    {
      "type": "CREATED",
      "description": "Envelope criado",
      "performedBy": "Maria Silva",
      "timestamp": "2026-03-25T10:15:30Z",
      "ipAddress": "200.150.100.50"
    },
    {
      "type": "SENT",
      "description": "Envelope enviado para assinatura",
      "performedBy": "Maria Silva",
      "timestamp": "2026-03-25T10:20:00Z",
      "ipAddress": "200.150.100.50"
    },
    {
      "type": "VIEWED",
      "description": "Documento visualizado por Carlos Eduardo Mendes",
      "performedBy": "Carlos Eduardo Mendes",
      "timestamp": "2026-03-26T15:40:12Z",
      "ipAddress": "189.100.50.25"
    },
    {
      "type": "SIGNED",
      "description": "Documento assinado por Carlos Eduardo Mendes",
      "performedBy": "Carlos Eduardo Mendes",
      "timestamp": "2026-03-26T15:42:00Z",
      "ipAddress": "189.100.50.25"
    },
    {
      "type": "VIEWED",
      "description": "Documento visualizado por Ana Paula Costa",
      "performedBy": "Ana Paula Costa",
      "timestamp": "2026-03-27T09:10:00Z",
      "ipAddress": "177.80.45.12"
    },
    {
      "type": "SIGNED",
      "description": "Documento assinado por Ana Paula Costa",
      "performedBy": "Ana Paula Costa",
      "timestamp": "2026-03-27T09:15:30Z",
      "ipAddress": "177.80.45.12"
    },
    {
      "type": "COMPLETED",
      "description": "Todas as assinaturas foram coletadas. Envelope concluido.",
      "performedBy": "Sistema",
      "timestamp": "2026-03-27T09:15:30Z",
      "ipAddress": null
    }
  ]
}

Campos da resposta

Campo	Tipo	Descricao
envelopeId	string	Identificador unico do envelope
events	array	Lista de eventos em ordem cronologica
events[].type	string	Tipo do evento
events[].description	string	Descricao legivel do evento
events[].performedBy	string	Nome de quem realizou a acao
events[].timestamp	string	Data/hora do evento (ISO 8601)
events[].ipAddress	string	Endereco IP de quem realizou a acao (pode ser null para eventos do sistema)

Tipos de eventos

Tipo	Descricao
CREATED	Envelope foi criado
SENT	Envelope foi enviado para os signatarios
VIEWED	Um signatario visualizou o documento
SIGNED	Um signatario assinou o documento
DECLINED	Um signatario recusou assinar
COMPLETED	Todas as assinaturas foram coletadas
CANCELED	Envelope foi cancelado pelo remetente
EXPIRED	Prazo de assinatura expirou
RESENT	Notificacao foi reenviada para um signatario

Validade juridica

A trilha de auditoria e um componente essencial para a validade juridica dos documentos assinados eletronicamente. Cada evento registra quem, quando e de onde a acao foi realizada.

401 - Nao autorizado

{
  "error": "UNAUTHORIZED",
  "message": "Token de autenticacao invalido ou expirado."
}

404 - Nao encontrado

{
  "error": "NOT_FOUND",
  "message": "Envelope nao encontrado ou nao pertence a sua organizacao."
}

Dica

A trilha de auditoria tambem esta disponivel no endpoint de Detalhar Documento dentro do campo auditTrail. Use este endpoint dedicado quando precisar apenas do historico de eventos.