Adicionar anexo (documento extra) via Modelo
Não utilize este endpoint caso algum signatário vá assinar com auth_mode:"certificadoDigital", pois este método de autenticação é, por enquanto, incompatível com documentos extras.
Adicionar documento extra via modelo
POST https://api.zapsign.com.br/api/v1/models/{{doc_principal_token}}/upload-extra-doc/
Esse endpoint permite que você anexe um documento extra ao documento principal a partir de um Modelo dinâmico (isto é, um .docx com variáveis que você sobe na ZapSign, que terá suas variáveis automaticamente substituídas e convertido para .pdf). Você deverá enviar os dados em JSON, bem como receberá eles nesse mesmo formato.
É possível anexar até 14 documentos (um por vez, isto é, uma requisição para cada anexo), totalizando 15 documentos que o signatário pode assinar de uma vez só.
Headers
Authorization*
string
Api token a frente do texto "Bearer".
Ex: Bearer c7f35c84-7893-4087-b4fb-d1f06c23
Request Body
template_id*
string
Identificador/token do template (modelo dinâmico)
Ex: https://app.zapsign.com.br/conta/modelos/{TEMPLATE_ID}
data[]['de']
string
Nome da variável a ser substituída.
Ex: "{{NOME COMPLETO}}"
data[]['para']
string
Valor a ser preenchido no lugar da variável. Ex: "João dos Santos"
Não há outros parâmetros a serem enviados na requisição, pois todos eles serão herdados do documento principal.
Exemplo de requisição
Exemplo de retorno
Perguntas frequentes
O que é um anexo/documento extra?
Caso você utilize a plataforma web da ZapSign, irá perceber que é possível subir vários PDFs de uma vez para serem assinados pelos mesmos signatários:
Assim, quando o signatário vai assinar o documento, ele se depara com a lista de todos eles, para assinar de uma vez só:
O documento principal será o número 1 e os documentos extras aparecerão para o signatário como documentos de número 2, 3, etc. Ao fazer um GET no documento principal, os documentos extras aparecerão no parâmetro "extra_docs".
O documento extra consome crédito de API? Sim. Cada documento extra conta igual a um documento principal. Assim, caso você adicione 14 documentos extras a um documento principal, isso contará como "15 créditos" de API, e não um só.
Eu consigo posicionar assinaturas no documento extra? Sim! Basta encaminhar o token do documento extra no endpoint de posicionar assinaturas.
Adicionei um anexo sem querer. Tem como remover/desfazer o engano? Não. Por enquanto não é possível remover um anexo, depois de adicionado.
Last updated
Was this helpful?
