v1

latestOpenAPI 3.1.02026-08-041060342.7 KB

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

post/api/files/upload/requests

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

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

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

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_monthsinteger

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.

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

Response

200

messagestring

Mensagem de confirmação retornada pela API após o envio da solicitação.

Example response

{
  "data": {
    "id": 207122,
    "signing_key": "WYslkgsfW972xOb6mYXNh4jgwzvDNKtD",
    "document": "prt5Z5OfDYa7bn5uXeAgsc1xXa0h8Z1o",
    "email": "exemplo@suaempresa.com",
    "message": "Teste",
    "sender": {
      "id": 1,
      "name": "Assinatura",
      "last_name": "Assinaturas",
      "email": "contato@assinatura.com",
      "permissions": [
        "edit"
      ]
    },
    "send_time": "21/11/2023 18:28:40",
    "update_time": "21/11/2023 18:28:41",
    "creted_at": "21/11/2023 18:28:40",
    "status": "Pending",
    "observer": [
      "contato2@suaempresa.com"
    ]
  },
  "message": "Sua solicitação foi enviada com sucesso!"
}