POST Upload and send request

post

https://app.assinadoc.com/api/files/upload/requests

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]
 ]

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

Body Params

folder

string

Pasta na qual o documento deve ficar, caso não seja informado ele irá ficar na pasta raíz 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 Base64.

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

int32

message

string

required

Mensagem enviada para o destinatário.

expire_date

string

Deve ser uma data válida no formato Y-m-d H:i:s e posterior ao momento atual.

due_months

int32

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

Tipo de validação padrão ao assinar um documento.

4 - QR Code no rodapé do documento (Sem página final).

3 - Página final de validação e QR Code.

2 - Sem QR Code no topo, apenas página no final.

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.

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 esse campo você pode solicitar uma selfie ou documento de identidade no momento da assinatura.

Responses

200200

400400