Histórico de Atividades

Retorna a trilha de auditoria de um envelope: todos os eventos registrados, em ordem cronológica, desde a criação.

Requisição

GET /v1/envelopes/{id}/audit

Headers

Header	Tipo	Obrigatório	Descrição
Authorization	string	Sim	Bearer {token}

Parâmetros de URL

Parâmetro	Tipo	Obrigatório	Descrição
id	number	Sim	Identificador do envelope

Exemplo de requisição

curl -X GET \
  https://api.tapsign.com.br/v1/envelopes/512/audit \
  -H "Authorization: Bearer {token}"

Resposta

200 - Sucesso

A resposta é uma lista, do evento mais antigo para o mais recente.

[
  {
    "id": 9001,
    "envelopeId": 512,
    "actorEmail": null,
    "eventType": "CREATED",
    "ipAddress": null,
    "metadata": null,
    "createdAt": "2026-09-12T14:31:00Z"
  },
  {
    "id": 9002,
    "envelopeId": 512,
    "actorEmail": null,
    "eventType": "SENT",
    "ipAddress": null,
    "metadata": null,
    "createdAt": "2026-09-12T14:35:00Z"
  },
  {
    "id": 9003,
    "envelopeId": 512,
    "actorEmail": "[email protected]",
    "eventType": "VIEWED",
    "ipAddress": "189.100.50.25",
    "metadata": { "signerId": 880 },
    "createdAt": "2026-09-12T15:40:12Z"
  },
  {
    "id": 9004,
    "envelopeId": 512,
    "actorEmail": "[email protected]",
    "eventType": "SIGNED",
    "ipAddress": "189.100.50.25",
    "metadata": { "signerId": 880 },
    "createdAt": "2026-09-12T15:42:00Z"
  }
]

Campos da resposta

Campo	Tipo	Descrição
id	number	Identificador do evento
envelopeId	number	Envelope do evento
actorEmail	string	E-mail de quem agiu. Em eventos do dono ou do sistema (criação, envio, cancelamento, expiração, conclusão), vem null
eventType	string	Tipo do evento (tabela abaixo)
ipAddress	string	IP de quem agiu, quando registrado (pode ser null)
metadata	object	Dados extras do evento, como signerId e, na recusa, reason (pode ser null)
createdAt	string	Data e hora do evento (ISO 8601, UTC)

Tipos de eventos

Tipo	Quando é registrado
CREATED	O envelope foi criado
BUNDLE_CREATED	O envelope foi criado dentro de um pacote de documentos
SENT	O envelope foi enviado aos signatários
VIEWED	Um signatário abriu o link de assinatura
IDENTITY_CONFIRMED	Um signatário confirmou a identidade na tela de assinatura
SIGNED	Um signatário assinou
DECLINED	Um signatário recusou. O motivo vem em metadata.reason
COMPLETED	Todos os signatários assinaram e o envelope foi concluído
CANCELED	O dono cancelou o envelope
EXPIRED	O prazo venceu antes da conclusão

Validade jurídica

A trilha de auditoria compõe a comprovação da assinatura eletrônica: cada evento registra o tipo, a data e, quando há, quem agiu e o IP de origem.

Erros

Código	Quando acontece
401	Token ausente ou inválido
404	O envelope não existe ou não é da sua conta

Exemplo de erro 404 (com Accept-Language: pt-BR):

{
  "title": "Recurso não encontrado!",
  "status": 404,
  "details": "Recurso não encontrado",
  "timestamp": "2026-09-12T16:20:00Z",
  "fields": {}
}

Dica

O histórico não vem junto em Detalhar Documento. Para acompanhar eventos em tempo real, use webhooks.