📘
Requisição para a criação de lotes na Clicksign Esta é uma requisição POST para /api/v1/batches. No body, deverão ser enviados os atributos do lote, se aplicáveis.

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

Atributos

Atributo	Descrição	Exemplo
`document_keys` Obrigatório	Chave(s) do(s) documento(s) na Clicksign.	["fe98d97a-7f74-4303-b9aa-8f1d53d52eeb"]
`signer_key` Obrigatório	Chave única do signatário dentro da Clicksign.	"79301388-9567-4320-90ce-9e6f60e70d28"
`summary`	`true`: mostrará a listagem dos documentos do lote de forma colapsada para assinatura. `false`: mostrará os documentos do lote na sequência, um embaixo do outro.	true

Atributo

Descrição

Exemplo

document_keys Obrigatório

Chave(s) do(s) documento(s) na Clicksign.

["fe98d97a-7f74-4303-b9aa-8f1d53d52eeb"]

signer_key
Obrigatório

Chave única do signatário dentro da Clicksign.

"79301388-9567-4320-90ce-9e6f60e70d28"

summary

true: mostrará a listagem dos documentos do lote de forma colapsada para assinatura.

false: mostrará os documentos do lote na sequência, um embaixo do outro.

true

🚧
Os lotes podem no máximo 500 document_keys.

❗️
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

Request

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

{
  "batch": {
    "signer_key": "f2fb38c2-620a-71b7-afe7-8a565e277f50",
    "document_keys": [
      "094de923-0eab-2ade-0268-15ca89c418b9",
      "a9add7dd-5f28-7f51-65ad-da7fdc4043f4"
    ],
    "summary": true
  }
}

Response

HTTP/1.1 201 Created
Content-Type: application/json; charset=utf-8

{
  "batch": {
    "key": "4a84a059-fbce-4a61-a887-dfff4a94f409",
    "request_signature_key":"7fb6585e-a835-44af-83ec-9d2a5a25e593",
    "url": "https://sandbox.clicksign.com/sign/7fb6585e-a835-44af-83ec-9d2a5a25e593",
    "signer_key": "f2fb38c2-620a-71b7-afe7-8a565e277f50",
    "document_keys": [
      "094de923-0eab-2ade-0268-15ca89c418b9",
      "a9add7dd-5f28-7f51-65ad-da7fdc4043f4"
    ],
    "summary": true,
    "created_at": "2020-02-13T13:36:11.626-03:00",
    "updated_at": "2020-02-13T13:36:11.626-03:00"
  }
}