📘
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/sms. 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/sms?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 SMS

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. É possível adicionar o parâmetro `{{token}}`, que adiciona o valor do token dentro da mensagem.	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. `phone_number`: Número de telefone do host.	{ "name" : "Marcos Zumba", "email" : "[email protected]" }

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.

É possível adicionar o parâmetro {{token}}, que adiciona o valor do token dentro da mensagem.

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.
phone_number: Número de telefone do host.

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

❗️
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/sms?access_token={{access_token}} HTTP/1.1
Host: sandbox.clicksign.com
Content-Type: application/json
Accept: application/json

{
    "request_signature_key": "b9712106-c84a-44b4-a115-4a2aed9ebcfb",
    "message":"Por favor, assine o documento", 
    "signature_host" : 
        {
            "name": "Marcos Zumba",
            "email": "[email protected]",
            "phone_number": "3123989876"
         },
    "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"
    }
  }

Response

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