Criar documento via Modelo
Last updated
Was this helpful?
Last updated
Was this helpful?
POST https://api.zapsign.com.br/api/v1/models/create-doc/
Este endpoint permite criar um documento por meio de um Modelo DOCX. Você só precisa enviar os dados que substituirão os campos dinâmicos do modelo no formato JSON e receberá a resposta também em JSON.
Authorization*
string
Api token a frente do texto "Bearer".
Ex: Bearer c7f35c84-7893-4087-b4fb-d1f06c23
template_id*
string
Identificador/token do template (modelo dinâmico)
Ex: https://app.zapsign.com.br/conta/modelos/{TEMPLATE_ID}
signer_name
string
Nome do signatário do documento. Se houver mais de um signatário no documento, você poderá adicioná-lo posteriormente via endpoint Adicionar signatário.
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"
signer_email
string
Email do signatário do documento. Se houver mais de um signatário no documento, você poderá adicioná-lo posteriormente via endpoint Adicionar signatário.
signer_phone_country
String
Código do pais do signatário do documento (Ex: 55). Se houver mais de um signatário no documento, você poderá adicioná-lo posteriormente via endpoint Adicionar signatário.
signer_phone_number
String
Numero do telefone do signatário do signatário do documento (Ex: 11999999999). Se houver mais de um signatário no documento, você poderá adicioná-lo posteriormente via endpoint Adicionar signatário.
lang
string
idioma do documento. Valores possíveis:
"pt-br" (português)
"es" (espanhol)
"en" (inglês).
Default: "pt-br"
disable_signer_emails
boolean
para desativar os e-mails enviados aos signatários, envie esse parâmetro como true. Default: false
brand_logo
string
se deseja personalizar a logomarca da experiência de assinatura deste documento específico, envie a URL da imagem (precisa ser um link publicamente acessível).
Default: ""
brand_primary_color
string
se deseja personalizar a cor primária (do botão) da experiência de assinatura deste documento específico, envie em rgb ou hexadecimal.
Ex: "#0011ee".
Default: ""
brand_name
string
se deseja personalizar o nome do remetente dos e-mails enviados ao signatário, insira aqui o nome da marca. Por exemplo, se inserido "XPTO Advogados", o remetente do e-mail será "XPTO Advogados via ZapSign". Max-length: 100 caracteres.
Default: ""
external_id
string
ID do documento na sua aplicação.
Default: ""
folder_path
string
caminho da pasta dentro da ZapSign em que o documento será colocado. Se as pastas não existirem, serão criadas automaticamente. Requisitos: (1) o folder_path pode ter até 255 caracteres, (2) cada pasta pode ter até 50 caracteres, (3) há um limite de 5 níveis de pasta.
Ex.: "/api/" ou "/pasta1/pasta2/pasta3/".
Default: "/" (sem pasta).
created_by
string
e-mail do usuário que será definido como criador do documento, para fins de organização interna. Caso o e-mail não exista ou não seja usuário da sua conta, este parâmetro será ignorado.
Default: ""
(documento terá como criador aquele usuário que criou o modelo)
send_automatic_email
boolean
Se true, a ZapSign irá enviar um e-mail ao signatário com o link para assinar o documento. Se false (default), você é quem se encarregará de compartilhar o link de assinatura com o signatário, seja pelo seu site, widget, WhatsApp, SMS, e-mail, chat etc. Observação: para isso funcionar, é obrigatório que o email do signatário seja definido com um campo dinâmico, por exemplo {{EMAIL DO CLIENTE}}, e esse valor seja enviado junto da requisição.
custom_message
string
(apenas relevante caso send_automatic_email: true).
A custom_message é a mensagem personalizada que você pode inserir no e-mail enviado pela ZapSign ao signatário.
Exemplo: "Olá Fulano, \n Este é o seu contrato de trabalho. \n Abraços, Equipe XPTO". O símbolo \n serve para "pular uma linha" no texto do e-mail.
Default: ""
signer_has_incomplete_fields
bolean
Caso definido como true, o signatário será direcionado para preencher o formulário do modelo antes de assinar o documento. Observação: valores enviados em data já estarão preenchidos, sem que o signatário precise preencher novamente. Default: false.
reminder_every_n_days
integer
Representa o intervalo de dias entre os lembretes que serão enviados para os signatários, enquanto o signatario não assinar. Serão executadas no máximo 3 tentativas. Observação: este campo só deve ser preenchido se send_automatic_whatsapp ou send_automatic_email forem true Exemplo: se definido como 7 será enviada uma tentativa a cada 7 dias, até que o usuario assine, por no máximo 21 dias.
allow_refuse_signature
boolean
Se verdadeiro, os signatários tem a opção de se recusar a assinar. Default: false.
disable_signers_get_original_file
boolean
Se verdadeiro, os signatários não tem a opção de baixar o documento original. Default: false.
send_automatic_whatsapp
boolean
send_automatic_whatsapp_signed_file
boolean
signature_order_active
boolean
Se verdadeiro, as assinaturas do signatário serão solicitadas sequencialmente. Default: false. Sempre verdadeiro quando signer_has_incomplete_fields = true.
Metadata
Array
Metadados personalizados enviados na criação do documento, no formato de pares key e value. Essas informações aparecem apenas nos webhooks de criação, assinatura, recusa e exclusão.
Após uma requisição bem sucedida, você deverá receber uma resposta como essa:
O que você deverá fazer com essa resposta é enviar o link de assinatura para o signatário através da sua aplicação.
O link de assinatura consiste na rota: https://app.zapsign.com.br/verificar/{signer_token}
Ou seja, no exemplo acima, você deve enviar o seguinte link de assinatura ao signatário: - https://app.zapsign.com.br/verificar/921c115d-4a6e-445d-bdca-03fadedbbc0b E agora é só aguardar que o signatário assine!
Acesse nossa central de ajuda e veja o passo a passo completo:
Tem alguma duvida? Utilize nossa inteligência artificial treinada com toda a documentação da API =)
Para acessar a sua lista de templates clique aqui:
Se true, a ZapSign irá enviar uma mensagem por WhatsApp ao signatário com o link para assinar o documento. Se false (default), , seja pelo seu site, widget, WhatsApp, SMS, e-mail, chat etc. Observação: para isso funcionar, é obrigatório que o phone_country e phone_number do signatário sejam definidos e cada envio automático via WhatsApp custa R$ 0,50. Adicione créditos em .
Se true, a ZapSign irá enviar uma mensagem por WhatsApp ao signatário com o link para o arquivo assinado. Se false (default), , seja pelo seu site, widget, WhatsApp, SMS, e-mail, chat etc. Observação: para isso funcionar, é obrigatório que o phone_country e phone_number do signatário sejam definidos e cada envio automático via WhatsApp custa R$ 0,50. Adicione créditos em .
Atenção: os links retornados em original_file e signed_file são temporários e duram 60 minutos. Caso seu sistema necessite salvar estes links é recomendado que sejam baixados em uma CDN própria ou que o endpoint de seja consultado sempre para garantir que seu usuário sempre receberá um link válido.
Mais de um signatário? Se você quiser adicionar mais signatários, utilize os endpoints "" e "", receba o token do novo signatário e envie o link de assinatura como explicado acima.
