⚠️

Importante: Em meados de 2026 a API 1.9 será descontinuada. Ela não receberá mais atualizações, melhorias ou suporte técnico. Todas as evoluções da plataforma estão sendo direcionadas exclusivamente para a versão 3.0 (Envelope).

Por que atualizamos nossa API?

A versão antiga da API (1.9) não modelava o que realmente acontece na assinatura: pessoas, documentos e regras caminhando juntas até a conclusão de um acordo. Essa lógica ficava espalhada entre Document, List, Batch e Signature, o que gerava acoplamento, pouco espaço para ajustes e difícil evolução. Nossa versão 3.0 Envelope trata cada envio como uma transação. Você cria o envelope (draft), adiciona os documentos e as pessoas que deverão assiná-los, define requisitos que ligam quem assina o quê e como ela será autenticada, e então ativa. Tudo fica explícito (Requirements e Evidence), cada pessoa interage só com o que precisa, dá para ajustar, os erros são mais claros e os webhooks mais granulares.

Resultado: menos retrabalho, mais flexibilidade e uma base sólida para recursos novos.

Comparação: 1.9 vs 3.0

O diagrama a seguir ilustra as entidades e seus relacionamentos nas duas arquiteturas, destacando a complexidade da arquitetura antiga e a flexibilidade da nova.

1.9

Sistema baseado em processamento sequencial de documentos individuais com relacionamentos complexos e acoplados.

• Documento como entidade central
• Signatários acoplados ao documento
• Configurações distribuídas
• Processamento individual
• Relacionamentos implícitos

3.0

Sistema baseado em transações que agrupam documentos, pessoas e requisitos em uma única entidade coesa e flexível.

• Envelope como container de transação
• Entidades desacopladas e flexíveis
• Configurações centralizadas
• Processamento em massa inteligente
• Relacionamentos explícitos via Requirements

Glossário de termos essenciais

Entenda as principais diferenças arquiteturais entre as duas versões da API Clicksign.

Envelope

Na API 1.9, os documentos eram enviados de forma isolada. Agora temos a figura do Envelope: um container que grupa documentos, signatários e requisitos em uma única entidade, representando uma transação completa, e facilitando a gestão dos documentos que são enviados juntos.

Signatário (Signer)

Pessoa que assina o documento. Agora os signatários são adicionados ao Envelope e conectados aos documentos por meio de Requirements. Na 1.9, todos precisavam assinar todos os documentos; agora é possível enviar vários de uma vez e definir quem assina o quê, ou apenas observa.

Documento (Document)

Arquivo que será assinado, adicionado ao Envelope. Na nova arquitetura, documentos são mais simples - não carregam lógica de signatários ou configurações. Isso fica no Envelope e nos Requirements.

Requisito (Requirement)

Um Requirement conecta um signatário a um documento. Existem dois requisitos obrigatórios: Qualificação (define em qual papel o signatário assina; ex.: Contratante) e Autenticação (define qual método de autenticação será utilizado; ex.: Biometria facial). Ele substitui o "List" da API 1.9.

Evidência (Evidence)

Representação das "provas" criadas pelos signatários para cumprir os Requirements. Cada Evidence tem um tipo específico e artefatos associados (imagens, textos, etc.), ex.: a imagem da Biometria facial. Substitui o conceito de "Signature" da API 1.9.

Notificação (Notification)

Disparo das notificações para os signatários, permitindo que você os informe sobre a necessidade de assinatura dos documentos enviados.

Fluxo do novo processo de assinatura

Entenda como funciona o processo completo na nova arquitetura, desde a criação até a finalização.

1. Criar Envelope - Adicionar Documentos
2. Adicionar Documentos - Upload dos arquivos que fazem parte da transação
3. Adicionar Signatários - Pessoas envolvidas no processo (incluindo observadores)
4. Criar Requirements - Definir o que cada pessoa precisa fazer com cada documento
5. Configurar Envelope - Prazos, idioma, mensagens, configurações gerais
6. Ativar Envelope - Iniciar o processo
7. Enviar Notificação - Informar todos os envolvidos

Pronto para ver na prática?

Comparativo técnico