Envelopes — Referência

​

Operações Disponíveis:

​

Envio

• POST /api/envelopes/send/base64 — enviar envelope com documento base64
• POST /api/envelopes/send/template — enviar envelope baseado em template (com ajustes)

​

Consulta e Listagem

• GET /api/envelopes — listar envelopes com filtros e paginação
• GET /api/envelopes/{envelopeId} — obter detalhes completos de um envelope
• GET /api/envelopes/{envelopeId}/history — obter histórico de ações do envelope

​

Gerenciamento

• POST /api/envelopes/resend — reenviar envelope para destinatários
• POST /api/envelopes/void — cancelar envelope (ação irreversível)

​

Características Principais

• Upload direto: Envie PDFs codificados em base64
• Templates: Use templates pré-configurados com ajustes
• Validação automática: Validação de PDF, campos e destinatários
• Limite de tamanho: Máximo 10MB por documento
• Múltiplos destinatários: Configure vários signatários e observadores
• Campos personalizáveis: Assinatura, texto, data, checkbox, radio
• Envio imediato: Sem criação isolada; o envio ocorre na mesma chamada

​

Gestão e Acompanhamento

• Listagem paginada: Com filtros por status, data e texto
• Detalhes completos: Acesso a todos os dados do envelope
• Histórico de auditoria: Rastreamento completo de todas as ações
• Reenvio inteligente: Apenas para destinatários pendentes
• Cancelamento controlado: Com justificativa obrigatória

​

Status do Envelope

​

Para quem é ideal:

• Integrações server-to-server: APIs robustas para sistemas corporativos
• Automações de workflow: Envio automático de contratos e documentos
• Sistemas de gestão: ERP, CRM e outras plataformas de negócio
• Aplicações personalizadas: Que precisam de controle total sobre o processo
• Compliance e auditoria: Com histórico completo e rastreabilidade

​

Autenticação

Authorization: Bearer <access_token>