POST Upload file

Com este endpoint você poderá enviar um novo arquivo ao sistema, para futuramente enviar para uma ou mais pessoas assinarem e/ou preencherem o mesmo.

ATENÇÃO! O envio do documento e dos templates possuem finalidades diferentes!

O upload de documentos é o envio simples de um arquivo, já o template precisa que no ato do envio, você defina seus campos de preenchimento e assinatura, para mais informações sobre os campos consulte a documentação dos templates ou de solicitações de assinaturas.

Para envio de documentos é necessário que o tipo da requisição seja um form-data!

Para enviar um documento para o sistema, você deverá passar alguns parâmetros conforme abaixo, porém destacamos aqui o parâmetro FILE.

Este parâmetro poderá ser de dois tipos:

Documento: Um documento nos formatos PDF, Word, Excel ou Power Point (Futuramente será necessário converte-los para PDF).
Base 64: Um código base64 exclusivo para PDF, com o início "data:application/pdf;base64,"

Conversão para PDF: Quando um documento for assinado ou uma solicitação de assinatura for realizada, a conversão de documentos Office para PDF será feita automaticamente.

As informações do documento como document_key não são alteradas, porém dados como o endpoint para download, o formato e o tamanho do mesmo serão ajustados.

Regras:

  • Formatos aceitos: pdf, doc, docx, xls e xlsx (outros respondem 403). PowerPoint não é aceito.
  • file pode ser enviado como arquivo (multipart/form-data) ou como string base64 com data URI (data:application/pdf;base64,...); em base64 use apenas PDF.
  • pass_owner e pass_user precisam ser enviados juntos e não são aceitos para documentos Word.
  • Se já existir um documento com o mesmo nome e extensão na empresa, o nome recebe um sufixo: "nome (1)", "nome (2)"...
  • optimizer: omitido, PDFs na versão 1.5 são otimizados automaticamente; true otimiza sempre; false nunca. O resultado vem em pdf_optimization.
  • O upload dispara o webhook FILE_UPLOADED e conta no uso mensal de arquivos; limites de disco/arquivos do plano respondem 403.

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.

departments
array of int32s

Departamento(s) o qual o documento deve pertencer.

departments
string
enum

Visibilidade padrão do documento.

Allowed:
string
required

Nome do documento na plataforma. Se já existir, recebe um sufixo numérico.

file
required

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

string

Senha do proprietário do PDF (permissões totais). Obrigatória quando pass_user é enviada; não aceita para Word.

string

Senha de abertura do PDF. Obrigatória quando pass_owner é enviada; não aceita para Word.

boolean

true otimiza o PDF sempre; false nunca; omitido, otimiza automaticamente PDFs na versão 1.5.

int32

Id de um usuário da sua empresa que constará como responsável pelo upload (padrão: usuário do token).

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.

Responses

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