Como enviar um documento para assinatura?

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 o Sign.Plus eSignature API.

Seguindo estes passos, você criará um envelope, adicionará um documento, definirá um destinatário, inserirá uma anotação na assinatura e, finalmente, enviará o envelope para assinatura.

Pré-requisitos

Passo 1: Criar um Envelope

Um envelope é um recipiente para documentos serem assinados por destinatários.

  1. Envie uma solicitação para o endpoint POST /v2/envelope para criar um novo envelope. {
    "name": "Meu envelope maravilhoso",
    "flow_type": "REQUEST_SIGNATURE",
    "legality_level": "SES",
    "expires_at": 1831280113,
    "sandbox": true
    }
  2. Inclua sua chave API no cabeçalho autorização .
  3. Em caso de sucesso, você receberá um objeto Envelope.

    { "id": "<string>" ... }
  4. Salve o id como o envelope_id

Passo 2: Adicione um documento ao seu envelope

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

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

  3. Enviar uma solicitação POST com o arquivo de documento no corpo da solicitação na forma multipart/form-data.
  4. Em caso de sucesso, você receberá um objeto Documento como resposta.
    { "id": "<string>" ... }

  5. Salve o id como o document_id para mais tarde.

Passo 3: Defina um destinatário para seu envelope

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

  2. Substituir {envelope_id} por sua ID do envelope.

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

    {
    "signing_steps": [
    {
    "recipients": [
    {
    "name": "John Doe", "email": "john. oe@exemplo. om", "papel": "SIGNER"
    } ] } ] }
  4. Em caso de sucesso, você receberá uma matriz de SigninStep.

  5. Navegue pela matriz e pegue o nome de id do destinatário para o qual você deseja adicionar o quadro de assinatura (anotação de assinatura). Save this id as the recipient_id.

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

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

  1. Use o endpoint POST /v2/envelope/{envelope_id}/annotation para adicionar uma anotação da assinatura.
  2. Substituir {envelope_id} por sua ID do envelope. 
  3. Send a POST request with the following JSON body:
    {
    "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 apropriados.

Passo 5: Envie seu envelope para assinatura

  1. Use o endpoint POST /v2/envelope/{envelope_id}/enviar para enviar o envelope.
  2. Substituir {envelope_id} por sua ID do envelope.
  3. Envie uma solicitação POSTpara este endpoint.
  4. Em caso de sucesso, o envelope será enviado ao destinatário para assinatura.

Conclusão

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

For more detailed information on each API endpoint used in this process, please refer to our API documentation.

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