Sign in

v1

latestOpenAPI 3.1.02026-08-041060342.7 KB

POST Create lote

Com este método, é possível criar um lote de documentos com até 50 arquivos.

Com o uso de lotes, você pode agrupar documentos e criar uma solicitação de lote (lote request) para enviá-los todos de uma só vez, otimizando o processo de coleta de assinaturas.

Ideal para fluxos em que múltiplos documentos precisam ser assinados simultaneamente por um ou mais participantes.

post/api/lotes

Request body

namestring required

Nome do lote a ser cadastrado

filestring[] required

É necessário enviar <strong>no mínimo 2 e no máximo 50 arquivos</strong>.<br><br>Para arquivos em Base64, utilize o seguinte formato: data:application/pdf;base64,<código_base64> <br>Também é possível definir o nome do arquivo utilizando o parâmetro name. Exemplo: data:application/pdf;name=meuarquivo.pdf;base64,<código_base64>

departmentsinteger[]

Departamento(s) o qual o documento deve pertencer

accessibility'Everyone' | 'Departments' | 'OnlyMe'

Visibilidade padrão do lote.

editablevalidateinteger

1 - QR Code no topo do documento (Sem página final). <br><br> Ao solicitar a assinatura na última página, sem posicioná-la, a página final será sempre gerada automaticamente. <br><br> 2 - Sem QR Code no topo, apenas página no final. <br><br> 3 - Página final de validação e QR Code no cabeçalho (Criaremos páginas extras). <br><br> 4 - QR Code no rodapé do documento (Sem página final). <br><br> 5 - Página final de validação e QR Code no rodapé (Criaremos páginas extras). <br><br> 6 - QR Code (Texto) na lateral esquerda. <br><br> 7 - QR Code (Texto) na lateral direita. <br><br>

optimizerboolean

Marca o documento para otimização, caso enviado 1 o sistema irá otimizar e achatar campos de formulário no documento

Response

200

Example response

{
  "data": {
    "id": 10,
    "company_id": 1,
    "name": "lote_1",
    "created_at": "2024-07-12 14:24:11",
    "updated_at": "2024-07-12 14:24:11",
    "files": [
      {
        "id": 101168,
        "name": "lote_1-1",
        "file_name": "V9kAvLtOfyk2iqe3azv5684OdfRzqLbR.pdf",
        "extension": "pdf",
        "size": 13,
        "status": "Unsigned",
        "document_key": "V9kAvLtOfyk2iqe3azv5684OdfRzqLbR",
        "editted": "No",
        "is_template": "No",
        "accessibility": "Everyone",
        "folder": "Source",
        "uploaded_by": {
          "name": "Exemplo",
          "last_name": "Exemplo"
        },
        "uploaded_on": "14/07/2024 14:24:12",
        "download": "https://app.plugsign.com.br/api/files/download/V9kAvLtOfyk2iqe3azv5684OdfRzqLbR"
      }
    ]
  }
}