Atualizações da API

Documentação v3.0

🆙 Versão mais recente e atualizada

• Criação de nova documentação com melhor experiência do usuário e organização por público-alvo.
• Guia de migração da API 1.9 para 3.0 com instruções passo a passo para desenvolvedores.
• Diagramas visuais para melhor compreensão dos conceitos da API do Envelope.
• Glossário de termos essenciais com definições práticas e exemplos.
• Separação clara por público:
  • Conteúdo específico para analistas de negócio (conceitos e casos de uso)
  • Seção técnica para desenvolvedores (implementação e código)

Documentação v2.1

• Criação de nova documentação a partir da implementação de Envelope.
• Criação de nova página de referência a partir da implementação de Envelope.
• Documentações incluídas:
  • Envelopes;
  • Documentos;
  • Signatários;
  • Requisitos;
  • Modelos;
  • Notificações;
  • Eventos;
  • Observadores;
  • Pastas;

Documentação v2.0

• Criação de nova documentação a partir da implementação de Envelope.
• Novas requisições GET de filtragem do Envelope: por data de criação, por data de modificação e por data-limite.
• Novas requisições GET: listar eventos por Envelope e listar eventos por documento.
• Ações de adição e exclusão de signatário e exclusão de documento no Envelope passaram a ser possíveis com status running.
• Adição do novo requisito de autenticação address_proof, que define o comprovante de endereço como autenticação.

🚧

Importante

Abaixo estão as versão antigas e desatualizadas da API. Não fornecemos mais atualizações para essas versões.

Documentação v1.9

• Atualização do campo phone_number referente ao novo padrão de dígitos em Criar signatário.
• Adicionado campo official_document_enabled para solicitar a coleta de fotos de documento oficial.
• Adicionado campo handwritten_enabled para solicitação de assinatura manuscrita.
• Adição da guia Assinatura Presencial.
• Adicionado campo signer_validation_fail no atributo validation.status.
• Adicionado campo location_required_enabled na criação do signatário.

Documentação v1.8

• Adicionada requisição para visualizar todos os documentos da conta.

Documentação v1.7

• Adicionado campo selfie_enabled ao signatário.

Documentação v1.6

• Adicionado campo whatsapp ao signatário.
• Adicionada requisição para enviar notificação por Whatsapp.

Documentação v1.5

• Adicionado campo sequence_enabled ao documento.
• Adicionado campo remind_interval ao documento.
• Adicionado campo group ao Adicionar signatário a documento.

Documentação v1.4

• Timeout de 5 segundos nos Webhooks.

Documentação v1.3

• Adicionada funcionalidade de limite de requisições.
• Adicionado o limite de 500 documentos por lote.

Documentação v1.2

• Adicionada requisição para duplicar documento finalizado.

Documentação v1.1

• Atualização geral da documentação da API.
• Adicionada requisição de criação de documentos através de Modelos.
• Adicionada requisição de criar de signatário.
• Adicionado campo delivery ao signatário.
• Adicionada requisição para adicionar signatário ao documento.
• Adicionado novas opções do campo sign_as para o signatário assinar o documento.
• Adicionada requisição para remover signatário do documento.
• Adicionada requisição para enviar notificação por e-mail.
• Adicionada requisição para enviar notificação por SMS.
• Adicionado campo window.origin ao Widget Embedded.
• Adicionado exemplo completo de uso do Widget Embedded.

Removidas as versões antigas das requisições abaixo devido à nova abordagem para lidar com signatários:

• Requisição de criação de documentos com signatário.
• Requisição de criação de signatário diretamente no documento.
• Requisição de remoção de signatário diretamente no documento.
• Requisição de notificação de solicitação assinatura.

Essas requisições continuam funcionando. Porém, seu uso não é mais recomendado.

Documentação v1.0

• Lançamento da versão inicial da documentação.