Como enviar um documento de um modelo existente?

Quem pode usar este recurso?

Available on all Developer API plans.

Todos os membros

Este artigo irá guiá-lo através do processo de envio de um documento para assinatura usando um modelo com o Sign.Plus eSignature API.

Ao seguir estes passos, você criará um envelope a partir de um modelo, definirá os detalhes do destinatário e enviará o envelope para assinatura.

Pré-requisitos

Passo 1: Crie um envelope a partir de um modelo

  1. Use o endpoint POST /v2/envelope/from_template/{template_id} para criar um novo envelope a partir de um template.
  2. Substituir {template_id}pelo ID do seu modelo existente.
    Onde posso encontrar meu ID de template?
  3. Envie uma solicitação POST para POST /v2/envelope/from_template/{template_id} com o seguinte corpo JSON:
    {
    "name": "Meu maravilhoso envelope de modelo"
    }
  4. Inclua sua chave API no cabeçalho autorização.
  5. On success, you will receive an Envelopeobject. {
    "id": "66eb7d0467d2d549b89fcb6d",
    // ...
    "signing_steps": [
    {
    "recipients": [
    {
    "id": "66eb7d0467d2d549b89fcb70",
    "uid": null,
    "name": "",
    "email": "",
    "role": "SIGNER",
    "verification": null
    }
    ]
    },
    {
    "recipients": [
    {
    "id": "66eb7d0467d2d549b89fcb71",
    "uid": null,
    "name": "",
    "email": "",
    "role": "RECEIVES_COPY",
    "verification": null
    },
    {
    "id": "66eb7d0467d2d549b89fcb72",
    "uid": null,
    "name": "",
    "email": "",
    "role": "SIGNER",
    "verification": null
    }
    ]
    }
    ],
    "documents": [
    // ...
    ],
    "notification": {
    // ...
    }
    }
  6. Salve o id retornado como envelope_id para futuras chamadas de API.
  7. Registre o idde cada destinatário para uso posterior no processo de assinatura.
    Exemplos:
    • 66eb7d0467d2d549b89fcb71: Primeiro SIGNER(Passo 1)
    • 66eb7d0467d2d549b89fcb71: RECEIVES_A_COPY(Etapa 1)
    • 66eb7d0467d2d549b89fcb72: Segundo SIGNER(Etapa 2)

Passo 2: Definir detalhes do destinatário

Se o seu modelo não tem os destinatários fixos e você precisa definir ou atualizar os detalhes do destinatário:

  1. Use o endpoint POST /v2/envelope/{envelope_id}/signing_steps para atualizar as informações do destinatário.
  2. Substitua {envelope_id} pela ID que recebeu no Passo 1.
  3. Send a POST request with the following JSON body:
    {
    "signing_steps": [
    {
    "recipients": [
    {
    "id": "66eb7d0467d2d549b89fcb70",
    "name": "John Doe",
    "email": "john.doe@example.com",
    "role": "SIGNER"
    }
    ]
    },
    {
    "recipients": [
    {
    "id": "66eb7d0467d2d549b89fcb71",
    "name": "Mark Twain",
    "email": "m.twain@example.com",
    "role": "RECEIVES_COPY"
    },
    {
    "id": "66eb7d0467d2d549b89fcb72",
    "name": "Jane Smith",
    "email": "j.smith@example.com",
    "role": "SIGNER"
    }
    ]
    }
    ]
    }
  4. Em caso de sucesso, você receberá uma matriz de objeto SigningStep.

Passo 3: Envie seu envelope para assinatura

  1. Use o endpoint POST /v2/envelope/{envelope_id}/enviar para enviar o envelope.
  2. Substitua {envelope_id} pelo seu ID do envelope a partir do Passo 1.
  3. Envie uma solicitação POST para este endpoint.
  4. Em caso de sucesso, o envelope será enviado para o(s) destinatário(s) para assinatura.

Conclusão

Você agora enviou com sucesso um documento para assinatura usando um modelo com a API Sign.Plus eSignature API. O(s) destinatário(s) receberá(s) uma notificação por e-mail com um link para assinar o documento.

Usar modelos pode simplificar significativamente seu fluxo de trabalho de assinatura, especialmente para documentos frequentemente usados, com layouts consistentes e requisitos de assinatura.

Este artigo foi útil?
Utilizadores que acharam útil: 0 de 0
More Articles in this section