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

Assinatura via API

📘

Requisição para a assinar documentos via API na Clicksign. Esta é uma requisição POST para /api/v1/sign. No body, deverão ser enviados os atributos da assinatura.

❗️

Atenção

O objetivo desta requisição é possibilitar que assinaturas recorrentes, como as realizadas por diretores ou procuradores de empresas, sejam automatizadas através da API. Para tanto, é necessário autorização prévia do signatário para a realização da mesma através da assinatura do Termo de Autorização.

Passo a passo

  1. Crie um signatário com o campo auths=["api"]. Veja documentação em Criar signatário.
  2. Preencha um dos formulários disponíveis abaixo, dependendo do ambiente no qual seu signatário tenha sido criado:
  3. Para o Ambiente de Produção, a Clicksign enviará para assinatura do Operador e do Signatário o Termo de Autorização.
  4. A Clicksign enviará o Segredo (secret) do Signer para o e-mail do Operador de forma criptografada em até 1 dia útil.
  5. Utilize o secret para calcular o parâmetro secret_hmac_sha256 que deverá ser enviado nesta requisição. Confira na tabela abaixo.

Requisição

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

Atributos para assinatura do documento

Atributo

Descrição

Exemplo

request_signature_key Obrigatório

Chave disponível no JSON de Adicionar signatário ao documento.

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

secret_hmac_sha256
Obrigatório

Calcule o HMAC SHA256 da soma do request_signature_key com o secret do Signer disponibilizado pela Clicksign.

Atenção: não formate o secret recebido pela Clicksign.

Validador online de HMAC

fffde3b71e5c2...

❗️

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/sign?access_token={{access_token}} HTTP/1.1
Host: sandbox.clicksign.com
Content-Type: application/json
Accept: application/json
{
  "request_signature_key": "870086c3-2831-7f2f-0ca3-98196cfb8428",
  "secret_hmac_sha256": "fffde3b71e5c252cd00cf26e4957cb58faa8ae6e2c804bbbf3de4ffda3588115"
}

Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8