These docs are for v1.0. Click to read the latest docs for v3.0.

Notificação da assinatura presencial por e-mail

POST /api/v1/send_presential_signature_request/email

📘

Requisição para notificar por e-mail a assinatura presencial de signatários na Clicksign. Esta é uma requisição POST para /api/v1/send_presential_signature_request/email. No body, deverão ser enviados os atributos do signatário.

Para realizar a assinatura, é possível que o signatário utilize o token recebido em nosso endereço público de assinatura.

POST /api/v1/send_presential_signature_request/email?access_token={{access_token}} HTTP/1.1
Host: sandbox.clicksign.com
Content-Type: application/json
Accept: application/json

Atributos para notificar a assinatura presencial por e-mail

Atributo

Descrição

Exemplo

request_signature_key Obrigatório

Chave disponível no JSON do documento utilizada nas requisições de notificação e no Widget Embedded.

3487ca99-0e37-9754-a9f7-6375c7ea6a0d

message

Mensagem que será enviada no body do e-mail de solicitação de assinatura aos signatários.

Utilize \n para quebra de linha.

Por favor, assine o documento.

signature_host
Obrigatório

Parâmetros para registrar o host da operação.

Opções:

  • name : Nome completo do host.

  • email : E-mail do host.

{
"name" : "Marcos Zumba",
"email" : "[email protected]"
}

recipient
Obrigatório

Parâmetros para identificar o destinatário da notificação.

Opções:

  • signer : Signatário.

  • signature_host : AnfitriãoAs opções possuem templates de e-mail próprios. Para mais informações, veja a descrição do atributo messages.

"recipient": "signer"

messages

Altera o conteúdo padrão do e-mail.

O conteúdo é dividido da seguinte maneira:

  • subject: Responsável pelo assunto da mensagem. Quando este campo não é informado, o padrão é “Assinatura presencial: {token} é o seu código de acesso”.

  • head: Cabeçalho.

  • greeting: Saudação.

  • principal: Mensagem principal.

  • final: Mensagem final que será exibida depois do botão de assinar.

  • button: Mensagem presente no botão de assinatura. Quando este campo não for informado, o padrão é “Assinar neste dispositivo”.

  • align: Posicionamento dos textos no e-mail de assinatura. Pode ser left (para alinhar à esquerda), center (para alinhar ao centro), right (para alinhar à direita), justify (para alinhar de forma justificada). Quando este campo não for informado, então o padrão é center.

  • without_token: Responsável por exibir ou não o token no corpo do e-mail. Os valores são true (não exibirá o token) e false (exibirá o token). O valor padrão de without_token é false.É permitido utilizar tags html para editar o texto. Inclua
    para pular uma linha, por exemplo.
    Além dessas informações, é possível adicionar parâmetros que serão substituídos na hora do envio dentro do atributo messages. São eles:

  • {{signer}}: Nome do signatário

  • {{document_name}}: Nome do documento.

  • {{token}}: Token.

  • {{token_expiration_at}}: Tempo da expiração do token em horas. O limite é 24h.

{
"messages": {
"head": "Proposta de Seguro",
"greeting": "Olá, {{signer}}< br/ >< br/ >",
"principal": "A empresa enviou a proposta de seu seguro. Para finalizar a contratação, clique no botão abaixo e assine eletronicamente o documento.",
"final": "< br/ >< br/ >< /br > Após assinar eletronicamente a proposta é finalizada.< br/ >< br / >< b >Conte sempre com a gente para cuidar das suas conquistas< /b >< br/>",
"without_token": false
}
}

❗️

Se a requisição para a Clicksign falhar

Sempre verifique o BODY da resposta. O retorno da requisição mostrará o motivo pelo qual a requisição não foi aceita pelos servidores da Clicksign. Confira mais detalhes em Mensagens de erro.

Exemplo completo

Request

POST /api/v1/send_presential_signature_request/email?access_token={{access_token}} HTTP/1.1
Host: sandbox.clicksign.com
Content-Type: application/json
Accept: application/json
{
    "request_signature_key": "3487ca99-0e37-9754-a9f7-6375c7ea6a0d",
    "message":"Por favor, assine o documento", 
    "signature_host" : 
        {
            "name": "Marcos Zumba",
            "email": "[email protected]"
         },
    "recipient": "signer",
    "messages": {
      "head": "Proposta de Seguro",
      "greeting": "Olá, {{signer}}<br/><br/>",
      "principal": "A proposta de seu seguro foi enviada. Para finalizar a contratação, por favor, clique no botão abaixo e assine eletronicamente o documento.",
      "final": "<br/><br/></br>Após assinar, a proposta e finalizada a contratação do seu Seguro, você receberá outro e-mail com o documento assinado, confirmando a sua contratação.<br/><br/><b>Conte sempre com a gente para cuidar das suas conquistas</b><br/><br/>Caixa Residencial",
      "without_token": false
    }
  }

Response

HTTP/1.1 202 Accepted
Content-Type: application/json; charset=utf-8