POST Upload and send request

Changed on Nov 3, 2026

Faz o upload de um documento (PDF ou Office) e envia para ser assinado por uma ou mais pessoas com assinatura na página de validação.

Este endpoint chama os endpoints de "Upload File" e "Send Request With Document", portanto as regras de validação de ambos se aplicam a ele.

Portanto é possível enviar documentos BASE64 (PDF) no padrão aceito em "Upload File" por exemplo, assim como o sistema vai converter documentos de office no ato da solicitação, como em "Send Request With Document".Regras:<ul><li>Formatos aceitos: pdf, doc, docx, xls e xlsx; <code>file</code> como arquivo (multipart/form-data) ou base64 com data URI (apenas PDF). PDFs 1.5/1.7 são otimizados automaticamente quando <code>optimizer</code> é omitido.</li><li>Sem <code>recipients</code>, a API usa o formato legado (<code>email[]</code>, <code>fields</code> por e-mail, <code>message</code> obrigatório).</li><li><code>due_months</code> é aceito, mas não é gravado no formato <code>recipients</code>.</li><li>O upload dispara o webhook <code>FILE_UPLOADED</code>; limites do plano respondem 403.</li></ul>Resposta: a solicitação criada no mesmo formato de <code>GET /api/requests/{signing_key}</code> (<code>data</code>) com <code>message</code> e, no formato <code>recipients</code>, <code>deliveries</code> (resultado dos envios por WhatsApp); com <code>silent_mode</code>, em vez de <code>deliveries</code> vem <code>silent_mode</code> (URLs de assinatura); com <code>chain: false</code> e vários destinatários, <code>data</code> é uma lista.

post/api/files/upload/requests

Request

Base URL
https://app.plugsign.com.br
URL
https://app.plugsign.com.br/api/files/upload/requests
Auth
API key in header Authorization

Request body

folderinteger

ID da pasta onde o documento deve ser armazenado. Caso não seja informado, o documento ficará na pasta raiz da empresa.

namestring required

Nome do arquivo que será criado no sistema.

filestring binary required

Arquivo PDF, DOC, DOCX, XLS ou XLSX (multipart/form-data) ou string base64 com data URI (apenas PDF).

chainboolean

Se a solicitação é em cadeia, ou seja, deve respeitar a ordem dos e-mails para envio ou se será enviada para todos ao mesmo tempo.

senderstring

Colaborador que aparecerá como remetente: id ou e-mail de um usuário da sua empresa (inexistente responde 404).

due_monthsinteger

Validade do documento em meses. Aceito, mas não é gravado no formato recipients.

observerstring[]

Os observadores irão receber comunicados referentes à situação da solicitação. Para isso, inclua uma lista de emails.

uploaded_byinteger

ID do usuário que enviou o documento.

editablevalidateinteger

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

optimizerboolean

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

silent_modeboolean

Quando ativado (True), o request não gera um e-mail para o cliente. Apenas o URL de assinatura e o e-mail serão retornados.

width_pagenumber required

Largura da página em pixels, este número será utilizado na hora de calcular as posições e campos de solicitação e/ou assinatura.

messagestring

Mensagem padrão para os destinatários (2 a 500 caracteres); obrigatória no formato legado.

signatureTagstring

Tag presente no PDF onde a assinatura deve ser posicionada; quando informado, recipients[].fields passa a ser opcional.

tagsobject

Para documentos DOCX com tags ${nome}: mapa tag → valor para preencher antes do envio.

certificate0 | 1 | 2 | 3

Certificado digital padrão para todos os destinatários.

expire_datestring

Data de expiração padrão (Y-m-d, futura).

Response

200

messagestring

"Sua solicitação foi enviada com sucesso!" ou, com silent_mode, "Sua solicitação foi criada com sucesso!".

Example response

{
  "data": {
    "id": 1601469,
    "signing_key": "5BKLud7blQX2m3NFzhSBgca0S8KD7stu",
    "document": "LuJrWJ01duSEWxHsZoaZ1aU3rHf7QYOg",
    "email": "signatario@exemplo.com",
    "message": "Por favor, assine o contrato.",
    "signature_type": "Testemunha",
    "expire_date": "31/12/2026 23:59:59",
    "send_time": "13/10/2026 14:45:43",
    "update_time": "13/10/2026 14:45:43",
    "creted_at": "13/10/2026 14:45:43",
    "status": "Pending",
    "doubleauth": "1"
  },
  "message": "Sua solicitação foi enviada com sucesso!"
}

Changes

Nov 3, 20263db1513040ea Revision changes
- breaking
  request property //// was restricted to a list of enum values
- breaking
  the / response's property type changed from boolean to integer for status
- breaking
  the / response's property type changed from boolean to integer for status
- breaking
  the / response's property type changed from boolean to integer for status
- warning
  the // request property's maxLength was set to 500
- warning
  the // request property's maxLength was set to 255
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  added the new Cancelled enum value to the / response property for the response status
- warning
  added the new Declined enum value to the / response property for the response status
- warning
  added the new Pending enum value to the / response property for the response status
- warning
  added the new Signed enum value to the / response property for the response status
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property //
- info
  added the new optional request property //
- info
  added the new optional request property //
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new 3.00 enum value to the request property //
- info
  added the new rubric enum value to the request property ////
- info
  added the new signature enum value to the request property ////
- info
  added the new text enum value to the request property ////
- info
  the request property type was generalized from integer to number
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  the response's property default value 0 was removed for the status
- info
  the response's property default value 0 was removed for the status
- info
  the response's property default value false was removed for the status
- info
  the response's property default value false was removed for the status
- info
  the response's property default value false was removed for the status
- info
  removed the all enum value from the / response property for the response status
- info
  removed the draw enum value from the / response property for the response status
- info
  removed the text enum value from the / response property for the response status
- info
  removed the upload enum value from the / response property for the response status

Operation history