POST Send request with template

O envio de solicitação de assinatura com templates é mais simples que o envio com documentos, uma vez que não é necessário definir os campos (Pois já foram definidos no upload).

Porém é importante se atentar a algo importante, o envio com templates é INDIVIDUAL, portanto se passar 3 e-mails no array "emails", o sistema vai gerar 3 documentos únicos e enviar um para cada e-mail, de forma que cada signatário vai assinar um documento único.

Lembre-se também que o template original NÃO VAI SER ASSINADO, e sim suas cópias que vão ser geradas com base no modelo original.

Selfie (image_selfie): Se o signatário deverá enviar uma selfie para a página de validação, neste caso a solicitação será feita SEM LOCAL DEFINIDO, somente pedindo a assinatura do usuário, esta e a foto vão ser inseridos na página final de validação do documento.

Documento (image_doc): Se o signatário deverá enviar uma foto do documento de identidade para a página de validação, neste caso a solicitação será feita SEM LOCAL DEFINIDO, somente pedindo a assinatura do usuário, esta e a foto vão ser inseridos na página final de validação do documento.

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

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
string
required

A document_key do documento que será enviado, necessário ser um documento, não um template.

email
array of strings
required

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

email*
int32
string
string
required

Mensagem enviada para o destinatário.

boolean
boolean
boolean
observer
array of strings

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

observer
string
enum

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

Allowed:
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
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
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.

int32
boolean
string

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

json

Com esse campo você pode solicitar uma selfie ou documento de identidade no momento da assinatura.

Responses

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