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

Permitir a assinatura presencial de signatários

POST /api/v1/send_presential_signature_request

📘

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

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

Atributos para permitir a assinatura presencial do signatário

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âmetro para registrar o host da operação.

  • name : Nome completo do host.

{
"name" : "Marcos Zumba"
}

📘

Acesse os links a seguir para ver os detalhes da notificação da assinatura presencial por E-mail e SMS .

❗️

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?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"
        }
}

Response

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

Veja em Visualizar signatários a explicação detalhada do JSON de retorno dos signatários.