POST Upload and send request

post

https://app.plugsign.com.br/api/files/upload/requests

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".

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

folder

int32

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

name

string

required

Nome do arquivo que será criado no sistema.

file

required

File/Base64 Arquivo PDF ou office como arquivo, para PDF é possível enviar um Base644.

chain

boolean

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.

sender

string

Identifica o colaborador que aparecerá como remetente deste documento. Pode ser o ID do usuário ou o e-mail dele.
Se omitido, o documento será enviado pela conta do admin da empresa.

due_months

int32

A validade do documento em meses, por exemplo, um contrato com 12 meses de validade. Nós iremos monitorar a data e avisaremos antes do vencimento, para que possam refazer a solicitação e reenviar para assinatura.

observer

array of strings

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

observer

uploaded_by

int32

ID do usuário que enviou o documento.

editablevalidate

int32

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.

optimizer

boolean

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

silent_mode

boolean

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_page

int32

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.

recipients

array of objects

Destinatários.

recipients

Response

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200