(Antigo) POST Upload and send request

post

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

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…

Exemplo para o campo request_image

"request_image": [
    [1,1,1]
 ]

O primeiro índice do request_image é utilizado para solicitar uma selfie no momento da assinatura, o segundo, um documento de identidade e o terceiro, a parte de trás do documento de identidade.

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

array of strings

required

E-mails e/ou Celulares com WhatsApp para envio, mínimo 1

email*

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.

message

string

Mensagem enviada para o destinatário

expire_date

string

Data de expiração para este destinatário. Deve ser uma data válida no formato Y-m-d e posterior à data atual.

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

signature_type

string

Tipo da assinatura (all, draw, text, upload)

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

send_finished

array of booleans

Opção para indicar se o usuário deve receber o documento após todas as assinaturas serem concluídas. O array deve seguir a mesma ordem e quantidade dos e-mails. Por padrão, o valor é true. Esse campo é válido apenas quando o valor de 'chain' for 0 (false)

send_finished

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

reminders

array of strings

E-mails e/ou Celulares para enviar lembrete. O array deve seguir a mesma ordem dos e-mails ou números de celular. O tamanho do array deve ser igual ou menor ao do array de e-mails/celulares. Este campo só funciona quando o valor de chain for 0 (false)

reminders

doubleauth

boolean

Este campo especifica se será realizada uma autenticação adicional para confirmar a assinatura. Quando ativado, o sistema enviará um token de validação para o e-mail e/ou WhatsApp do usuário. O usuário deverá inserir o token recebido para concluir a assinatura. Este campo é válido apenas quando o valor de 'chain' for 0 (false) e se aplica a todos os assinantes da requisição

request_image

json

Com este campo, você pode solicitar uma selfie, a parte da frente do documento de identidade ou de trás no momento da assinatura

width_page

int32

Este campo se torna obrigatório quando o campo fields for definido.

fields

json

Este campo deve ser um objeto de objetos, para cada e-mail passado no array emails, aqui deve ser passado um objeto com os campos de preenchimento e assinatura do usuário, na mesma ordem dos e-mails

Response

200200