Envelope

🚧

O envelope está ativo para contas criadas a partir de 01/07/2024. Caso receba o erro de serviço indisponível, entre em contato com [email protected]

📘

Esta é a segunda versão da documentação de API da Clicksign, que inclui o uso de envelopes via API. Envelopes são uma forma de agrupar documentos e signatários em uma única entidade, facilitando o gerenciamento e a assinatura de documentos. Caso queira consultar a versão anterior da documentação de API, que não usa envelopes, clique aqui. Caso tenha alguma dúvida ou sugestão, entre em contato com [email protected].

O Envelope na Clicksign é composto de pelo menos: um documento, um signatário, um requisito de qualificação e um requisito de autenticação. Com estes elementos mínimos, o Envelope pode ser ativado e enviado para a assinatura.

Passo a passo:

1. Criar Envelope: Requisição para criação do Envelope.

2. Adicionar novo documento no Envelope: Requisição para criação de documento no Envelope anteriormente criado.

3. Adicionar novo signatário no Envelope: Requisição para criação de um signatário para assinatura de um documento.

4. Adicionar requisito de autenticação: Cria um novo requisito no Envelope. Um requisito é uma condição que deve ser cumprida por um signatário para que ele possa assinar. "Autenticação" significa que o signatário deve enviar uma prova de identidade para assinar.

5. Adicionar requisito de qualificação: Cria um novo requisito no Envelope. Um requisito é uma condição que deve ser cumprida por um signatário para que ele possa assinar. O requisito de qualificação serve para indicar como o signatário deve assinar o documento.

6. Ativar Envelope: Requisição para ativar o Envelope anteriormente criado.

7. Notificar o Envelope para assinatura. Isso pode pode ser feito de duas maneiras:

Disparar notificação de signatário: Requisição para disparar notificação de signatário.

Disparar notificação de Envelope: Requisição para disparar notificação de Envelope.

Além desses passos, é possível Alterar Envelope, caso seja necessário.

Padrão JSON da API com Envelope

API da Clicksign utiliza JSON API como formato das requisições, tanto para requests como para response.

Conforme consta em Informações Gerais, há especificidades da API do Envelope quanto a isso. Nessa versão, o formato deve ser enviado através dos cabeçalhos HTTP: Accept: application/vnd.api+json e Content-Type: application/vnd.api+json.

Exemplo de requisição

GET /api/v3/envelopes/ HTTP/1.1
Host: sandbox.clicksign.com
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Authorization: access token