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.

Regras:

• O documento precisa ser um template DOCX com tags no formato ${nome} (use GET /api/files/template/tags/{document_key} para listá-las). Documentos sem tags respondem 400.
• tags é um objeto que mapeia cada tag ao seu valor: {"nome": "Maria", "cpf": "000.000.000-00"}.
• Se o DOCX tiver tags de assinatura (${assinatura...}), as posições vêm das tags e recipients[].fields é opcional; caso contrário, recipients[].fields é obrigatório. width_page padrão: 800.
• Sem recipients, a API usa o formato legado (email[] e message obrigatórios). sender aceita apenas id numérico.
• A API gera um novo documento PDF (com o name informado) e envia a solicitação; document na resposta é a document key desse novo documento.

Resposta: a solicitação criada no mesmo formato de GET /api/requests/{signing_key} (data) com message e, no formato recipients, deliveries (resultado dos envios por WhatsApp) ou, com silent_mode, silent_mode (URLs de assinatura).