POST Send request with doc template

Com este endpoint, você pode preencher as tags presentes em um template no formato DOCX. Ao preenchê-las, o documento será transformado em PDF e enviado para assinatura.

Essa funcionalidade permite a substituição de tags em seu documento. Por exemplo, se há uma tag ${name} e no campo tags é passado name => Teste, essa tag será substituída pelo valor fornecido.

Dessa forma, é possível substituir tags em seu documento antes de enviá-lo.

Exemplo json:
"tags": {
"name": "Teste"
}

Neste endpoint, também é possível predefinir tags de assinatura.

As tags devem obrigatoriamente conter a marcação ${assinatura_NOME} e estar configuradas com a cor da fonte branca (ou a mesma cor do fundo onde a tag está posicionada).

A ordem das tags deve corresponder exatamente à ordem dos e-mails enviados no request. Por exemplo, se o seu documento possui duas tags de assinatura:

  • ${assinatura_maria}
  • ${assinatura_joao}

A ordem dos e-mails no request deve ser a seguinte:

email 1: [email protected], referente à tag ${assinatura_maria}.

email 2: [email protected], referente à tag ${assinatura_joao}.

Observações:

  • Se o documento possuir 3 tags e no request forem enviados apenas 2 e-mails, a terceira tag será ignorada.

  • Se o documento possuir 3 tags e forem enviados 4 e-mails no request, o sistema posicionará automaticamente a quarta tag.

Desse modo, preze por deixar o número de tags de assinaturas e e-mails equivalentes.

Para garantir que a tag de assinatura seja posicionada corretamente, siga as seguintes especificações para o formato do documento:

  • Tamanho do Documento:
    • Formato: A4
    • Dimensões: 21 cm x 29,7 cm
  • Margens do Documento:
    • Margens: 2,54 cm em todos os quatro lados do documento

Para que o sistema de reconhecimento de tags funcione corretamente, é fundamental que não sejam utilizados espaçamentos nas mesmas.

  • Inválido: $ {name}
  • Válido: ${name}

Seguindo essas orientações, você assegura que a tag de assinatura será inserida no local adequado dentro do documento, evitando problemas de alinhamento.

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

Exemplo para o campo tags:

"tags": {  
    "name": "Teste"  
}

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.

Path Params
string
required
Body Params
string

Pasta na qual o documento deve ficar, caso não seja informado ele irá ficar na pasta raíz da empresa.

string
required

Nome do documento que será criado no sistema.

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.

email
array of strings
required

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

email*
int32
string
required

Mensagem enviada para o destinatário.

string

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

int32
json
required

Dado para preenchimento da tag, para tags iguais um basta, mas é necessário fornecer todas as tags.

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.

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