POST Upload and send request

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:

  • Formatos aceitos: pdf, doc, docx, xls e xlsx; file como arquivo (multipart/form-data) ou base64 com data URI (apenas PDF). PDFs 1.5/1.7 são otimizados automaticamente quando optimizer é omitido.
  • Sem recipients, a API usa o formato legado (email[], fields por e-mail, message obrigatório).
  • due_months é aceito, mas não é gravado no formato recipients.
  • O upload dispara o webhook FILE_UPLOADED; limites do plano respondem 403.

Resposta: a solicitação criada no mesmo formato de GET /api/requests/{signing_key} (data) com message e, no formato recipients, deliveries (resultado dos envios por WhatsApp); com silent_mode, em vez de deliveries vem silent_mode (URLs de assinatura); com chain: false e vários destinatários, data é uma lista.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
int32

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

string
required

Nome do arquivo que será criado no sistema.

file
required

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

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.

string

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

int32

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

observer
array of strings

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

observer
int32

ID do usuário que enviou o documento.

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.

boolean

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

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.

number
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
string
length between 2 and 500

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

string

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

tags
object

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

integer
enum
Defaults to 0

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

Allowed:
string

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

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json