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

Solicitar assinatura por SMS

POST /api/v1/notify_by_sms

📘

Requisição para enviar mensagem por SMS para um signatário solicitando assinatura de um documento ou de um lote. Esse é uma requisição POST para /api/v1/notify_by_sms.

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

Atributos da requisição

Atributo

Descrição

Exemplo

request_signature_key

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

  • *Nota:** é obrigatório que a autenticação do signatário seja sms.

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

❗️

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/notify_by_sms?access_token={{access_token}} HTTP/1.1
Host: sandbox.clicksign.com
Content-Type: application/json
Accept: application/json
{
  "request_signature_key": "0d5a9615-2bb8-3a23-6584-33ff436bb990"
}

Response

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