Como enviar um documento para assinatura?

Este artigo explica o processo de envio de um documento para assinatura utilizando a API de assinatura eletrónica Sign.Plus.

Seguindo estes passos, irá criar um envelope, adicionar um documento, definir um destinatário, inserir uma anotação de assinatura e, por fim, enviar o envelope para assinatura.

Pré-requisitos

• Uma conta Sign.Plus com um plano API
• O seu Personal Access Token

Passo 1: Criar um envelope

Um envelope é um contentor para documentos que serão assinados por destinatários.

1. Envie um pedido para o endpoint POST /v2/envelope para criar um novo envelope. {
"name": "My wonderful envelope",
"flow_type": "REQUEST_SIGNATURE",
"legality_level": "SES",
"expires_at": 1831280113,
"sandbox": true
}
2. Inclua a sua chave de API no cabeçalho Authorization .

3. Em caso de sucesso, receberá um objeto Envelope.

   { "id": "<string>" ... }

4. Guarde o id como o envelope_id

Passo 2: Adicionar um documento ao seu envelope

1. Utilize o endpoint POST /v2/envelope/{envelope_id}/document para adicionar um documento.

2. Substitua {envelope_id} pelo ID que recebeu no Passo 1.

3. Envie um pedido POST com o ficheiro do documento no corpo do pedido como multipart/form-data.

4. Em caso de sucesso, receberá um objeto Document como resposta.
   { "id": "<string>" ... }

5. Guarde o id como o document_id para utilização posterior.

Passo 3: Definir um destinatário para o seu envelope

1. Utilize o endpoint POST /v2/envelope/{envelope_id}/signing_steps para adicionar um destinatário.

2. Substitua {envelope_id} pelo ID do seu envelope.

3. Envie um pedido POST com o seguinte corpo JSON:

   {
"signing_steps": [
{
"recipients": [
{
"name": "John Doe", "email": "john.doe@example.com", "role": "SIGNER"
} ] } ] }

4. Em caso de sucesso, receberá uma matriz de SigninStep.

5. Percorra a matriz e retire o nome id do destinatário para o qual pretende adicionar a moldura de assinatura (anotação de assinatura). Guarde este id como o recipient_id.

Passo 4: Inserir uma anotação de assinatura no seu documento

Antes de adicionar uma anotação de assinatura, certifique-se de que definiu a sua assinatura na plataforma Sign.Plus.

1. Utilize o endpoint POST /v2/envelope/{envelope_id}/annotation para adicionar uma anotação de assinatura.
2. Substitua {envelope_id} pelo ID do seu envelope. 
3. Envie um pedido POST com o seguinte corpo JSON:
   {
"recipient_id": "<recipient_id>",
"document_id": "<document_id>",
"page": 1,
"x": 50,
"y": 20,
"width": 20,
"height": 60,
"required": true,
"type": "SIGNATURE",
}

   Substitua <recipient_id> e <document_id> pelos valores adequados.

Passo 5: Enviar o seu envelope para assinatura

1. Utilize o endpoint POST /v2/envelope/{envelope_id}/send para enviar o envelope.
2. Substitua {envelope_id} pelo ID do seu envelope.
3. Envie um pedido POST para este endpoint.
4. Em caso de sucesso, o envelope será enviado ao destinatário para assinatura.
   
   

Conclusão

Já enviou com sucesso um documento para assinatura utilizando a API de assinatura eletrónica Sign.Plus. O destinatário receberá uma notificação por e-mail com uma ligação para assinar o documento.

Para obter informações mais detalhadas sobre cada endpoint de API utilizado neste processo, consulte a nossa documentação da API.