PLplugsign

(Antigo) POST Upload and send request

Changed on

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/requestss

Request

  • Base URL
    https://app.plugsign.com.br
  • URL
    https://app.plugsign.com.br/api/files/upload/requestss
  • Auth
    API key in header Authorization

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

emailstring[] required

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

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.

messagestring

Mensagem enviada para o destinatário

expire_datestring

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

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

signature_typestring

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

editablevalidateinteger

1 - QR Code no topo do documento (Sem página final). <br><br> Ao solicitar a assinatura na última página, sem posicioná-la, a página final será sempre gerada automaticamente. <br><br> 2 - Sem QR Code no topo, apenas página no final. <br><br> 3 - Página final de validação e QR Code no cabeçalho (Criaremos páginas extras). <br><br> 4 - QR Code no rodapé do documento (Sem página final). <br><br> 5 - Página final de validação e QR Code no rodapé (Criaremos páginas extras). <br><br> 6 - QR Code (Texto) na lateral esquerda. <br><br> 7 - QR Code (Texto) na lateral direita. <br><br>

optimizerboolean

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

send_finishedboolean[]

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)

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

remindersstring[]

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)

doubleauthboolean

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

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

fieldsstring 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

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!"
}

Changes