Skip to main content
Este endpoint retorna o histórico completo de todas as ações realizadas em um envelope específico, incluindo criação, envio, visualizações, assinaturas e cancelamentos.
cURL
curl -X GET "https://api.formsign.com.br/api/envelopes/env_abc123456789/history" \
  -H "Authorization: Bearer <TOKEN>"

​
Parâmetros (Path)

​
envelopeId
string
required
ID único do envelope.

​
Tipos de Ações no Histórico

AçãoDescriçãoExecutor
envelope_createdEnvelope foi criadoRemetente
envelope_sentEnvelope foi enviadoSistema
envelope_openedDestinatário abriu o envelopeDestinatário
envelope_viewedDestinatário visualizou documentoDestinatário
field_filledCampo foi preenchidoDestinatário
envelope_signedEnvelope foi assinadoDestinatário
envelope_completedTodas assinaturas coletadasSistema
envelope_resentEnvelope foi reenviadoRemetente
envelope_voidedEnvelope foi canceladoRemetente
envelope_expiredEnvelope expirouSistema
reminder_sentLembrete enviadoSistema

​
Respostas

[
  {
    "envelopeId": "env_abc123456789",
    "action": "envelope_created",
    "executorId": "user_123",
    "executorName": "Maria Santos",
    "executorIp": "192.168.1.100",
    "creationDate": "2024-08-15T10:30:00Z"
  },
  {
    "envelopeId": "env_abc123456789",
    "action": "envelope_sent",
    "executorId": "system",
    "executorName": "Sistema",
    "executorIp": null,
    "creationDate": "2024-08-15T10:35:00Z"
  },
  {
    "envelopeId": "env_abc123456789",
    "action": "envelope_opened",
    "executorId": "rec_789",
    "executorName": "João Silva",
    "executorIp": "203.45.67.89",
    "creationDate": "2024-08-15T14:22:00Z"
  },
  {
    "envelopeId": "env_abc123456789",
    "action": "envelope_viewed",
    "executorId": "rec_789",
    "executorName": "João Silva",
    "executorIp": "203.45.67.89",
    "creationDate": "2024-08-15T14:23:00Z"
  },
  {
    "envelopeId": "env_abc123456789",
    "action": "field_filled",
    "executorId": "rec_789",
    "executorName": "João Silva",
    "executorIp": "203.45.67.89",
    "creationDate": "2024-08-15T14:25:00Z"
  },
  {
    "envelopeId": "env_abc123456789",
    "action": "envelope_signed",
    "executorId": "rec_789",
    "executorName": "João Silva",
    "executorIp": "203.45.67.89",
    "creationDate": "2024-08-15T14:27:00Z"
  },
  {
    "envelopeId": "env_abc123456789",
    "action": "envelope_completed",
    "executorId": "system",
    "executorName": "Sistema",
    "executorIp": null,
    "creationDate": "2024-08-15T14:28:00Z"
  }
]

​
Campos da Response

​
[]
array
Lista de ações ordenada cronologicamente (mais antiga primeiro).

​
Casos de Uso

  1. Auditoria: Rastrear quem fez o quê e quando
  2. Compliance: Evidências para processos legais
  3. Troubleshooting: Identificar onde o processo parou
  4. Análise: Entender o comportamento dos destinatários
  5. Notificações: Implementar alertas baseados em ações

​
Executores Especiais

ExecutorTipoDescrição
user_*UsuárioProprietário do envelope
rec_*DestinatárioQuem assina/visualiza
systemSistemaAções automáticas

​
Ordenação

As ações são sempre retornadas em ordem cronológica crescente (mais antiga primeiro), facilitando o acompanhamento sequencial do processo.
Retenção de Dados: O histórico é mantido indefinidamente para fins de compliance e auditoria. IPs são coletados apenas para ações de destinatários.
Análise de Padrões: Use o histórico para identificar padrões como tempo médio entre envio e assinatura, ou destinatários que frequentemente demoram para assinar.