Criar modelo DOCX

Os modelos DOCX na ZapSign permitem a automação de documentos com campos dinâmicos, facilitando a geração de contratos, acordos e outros documentos recorrentes. Criar documentos a partir de um modelo é útil para diversos casos de uso, como:

• Enviar um documento para que o signatário preencha um formulário e, com essas informações, gerar o documento. Exemplos: solicitação de apólice de seguro, termo de consentimento, inscrições para eventos, entre outros.

• Enviar um documento com informações parcialmente preenchidas, permitindo que o signatário complete o formulário e os campos restantes. O documento será criado com os campos dinâmicos, e o signatário continuará com o processo de assinatura. Exemplos: abertura de contas bancárias, solicitação de empréstimo.

• Preencher todos os campos dinâmicos para criar o documento final, onde o signatário apenas precisará assinar. Exemplos: contrato de trabalho, nota promissória, contrato de aluguel.

Criação do Documento no Word (DOCX)

Antes de utilizar o endpoint para criar um modelo na ZapSign, é necessário preparar o arquivo DOCX com os campos dinâmicos que serão substituídos por informações específicas em cada geração de documento. Para isso, siga estes passos:

Criação do Documento no Word (DOCX)

Antes de utilizar o endpoint para criar um modelo na ZapSign, é necessário preparar o arquivo DOCX com os campos dinâmicos que serão substituídos por informações específicas em cada geração de documento. Para isso, siga estes passos:

Criar o documento base

• Utilize Microsoft Word, Google Docs (exportando para DOCX) ou qualquer editor compatível com o formato DOCX.

• Redija o conteúdo do documento, garantindo que esteja bem estruturado.

Definir os campos dinâmicos

• Os campos dinâmicos são representados por chaves duplas {{campo}} dentro do documento.

• Exemplo: {{nome}}, {{data}}, {{email}}.

Evitar imagens e tabelas

• Recomendamos evitar o uso de imagens e tabelas no documento DOCX, pois isso pode interferir no correto funcionamento da funcionalidade.

Salvar e exportar

• Salve o arquivo no formato .docx.

• Verifique se os campos dinâmicos estão corretamente escritos e posicionados.

Após a preparação do documento DOCX, será possível utilizar o endpoint correspondente para enviar o modelo para a ZapSign e começar a gerar documentos de forma automatizada.

Exemplo

Criar modelo DOCX

POST https://api.zapsign.com.br/api/v1/templates/create

Headers

Name	Type	Description
Authorization*	string	Api token a frente do texto "Bearer". Ex: Bearer c7f35c84-7893-4087-b4fb-d1f06c23

Request Body

Name	Type	Description
name	string	Título do documento. String de até 255 caracteres
url_docx	string	Deve ser uma URL pública, e o tamanho máximo do documento é de 10MB.
base64_docx	string	Documento convertido para uma string em base64 (mais detalhes abaixo).
lang	string	Idioma do documento. Valores possíveis: "pt-br" (português), "es" (espanhol), "en" (inglês). Default: "pt-br"
observers	array<string>	Representa os observadores do documento (limite de 20), ou seja, endereços de e-mails que serão notificados após a conclusão do fluxo de assinatura. É um array de strings.
first_signer	Object	Configuração do signatário do documento.

Configurando o Signatário

Esses campos permitem ajustar a experiência de assinatura, como o método de autenticação.

Os dados do signatário (nome, e-mail e telefone) são definidos ao criar o documento a partir de um modelo.

first_signer

• blank_email (boolean): Se definido como true, o e-mail do signatário não será solicitado e não será incluído no relatório de assinatura. É obrigatório ter o e-mail OU o número de telefone do signatário. Valor padrão: false.

• blank_phone (boolean): Se definido como true, o número de celular do signatário não será solicitado e não será incluído no relatório de assinatura. É obrigatório ter o e-mail OU o número de telefone do signatário. Valor padrão: false.

• qualification (string): Papel do signatário que será exibido no relatório de assinatura. Por exemplo, "Testemunha" será mostrado como "Assinou como Testemunha". Valor padrão: "".

• auth_mode (string): Escolha o método de autenticação para o signatário. Isso adiciona mais segurança ao documento assinado. Para mais informações sobre os métodos de autenticação, clique aqui. Valor padrão: "assinaturaTela".

auth_mode	Descrição	Custo
"assinaturaTela"	Assinatura diretamente na tela.	Sem custo
"tokenEmail"	Envio de token via e-mail para autenticação.	Sem custo
"assinaturaTela-tokenEmail"	Combinação de assinatura na tela e token enviado por e-mail.	Sem custo
"tokenSms"	Envio de token via SMS para autenticação.	R$0,10 por envio
"assinaturaTela-tokenSms"	Combinação de assinatura na tela e token enviado por SMS.	R$0,10 por envio
"tokenWhatsapp"	Envio de token via WhatsApp para autenticação.	5 créditos
"assinaturaTela-tokenWhatsapp"	Combinação de assinatura na tela e token enviado por WhatsApp.	5 créditos
"certificadoDigital"	Autenticação com certificado digital.	5 créditos
"CPF"	Autenticação com verificação de CPF.	Sem custo
"assinaturaTela-cpf"	Combinação de assinatura na tela e verificação de CPF avançado.	Sem custo

• require_selfie_photo (boolean): Se definido como true, o signatário será solicitado a tirar uma selfie durante o processo de assinatura (não há validação da foto). Valor padrão: false.

• require_document_photo (boolean): Se definido como true, o signatário será solicitado a tirar uma foto da frente e do verso do seu documento de identidade durante o processo de assinatura (não há validação da foto). Valor padrão: false.

• selfie_validation_type (string): Métodos biométricos avançados para validar a identidade do signatário. Para saber mais sobre cada método, clique aqui.

Selfie_validation_type	Descrição	Paises	Valor por validação
"liveness-document-match"	Reconhecimento facial que solicita que o signatário faça o upload de uma foto do documento de identidade e grave o rosto. Valida que a pessoa é a mesma do documento e que está presente no momento da assinatura	Todos os países	15 creditos
"liveness-NXCD"	Valida que a pessoa está presente no momento da assinatura com um vídeo passivo (liveness)	Todos os países	15 creditos
“face-match-and-datavalid”	Autenticação via verificação facial com correspondência no banco de dados do governo (Serpro), confirmando o CPF e a CNH.	Disponível somente para o Brasil.	35 créditos
“identity-verification-global”	Verificação global da identidade do signatário no momento da assinatura, incluindo autenticação do documento e correspondência facial.	Todos os países	50 créditos

Request

{
    "name": "Nome do modelo",
    "docx_url": "https://zapsign.s3.amazonaws.com/dev/2025/1/docs/1b1e8e16-b9ce-45f4-8dc8-c0320af371a5/29812f55-eb17-4182-b65e-09e895a861ad.docx",
    "lang": "pt-br",
    "observers": [
        "[e-mail]"
    ],
    "first_signer": {
        "blank_email": false,
        "blank_phone": false,
        "auth_mode": "assinaturaTela",
        "require_selfie_photo": false,
        "require_document_photo": false,
        "selfie_validation_type": "",
        "qualification": "Aprovador"
    }
}

Response

{
    "token": "272xxxd4-ecda-47xx2-be7e-59e2beb752xx",
    "template_type": "docx",
    "name": "Nome do modelo",
    "active": true,
    "template_file": "https://zapsign.s3.amazonaws.com/dev/2025/1/api/45f39edb-c78d-42e4-a450-22cd7c62d656.docx?AWSAccessKeyId=AKIASUFZJ7JCTI2ZRGWX&Signature=v8haa5obmuOzV88e3naQDXnPVr8%3D&Expires=1738258954",
    "created_at": "2025-01-30T16:42:34.703412Z",
    "last_update_at": "2025-01-30T16:42:34.741300Z",
    "redirect_link": "",
    "folder_path": "/",
    "lang": "pt-br",
    "signers": [
        {
            "name": "Signatario 1",
            "auth_mode": "assinaturaTela",
            "email": "",
            "phone_country": "55",
            "phone_number": "",
            "lock_name": true,
            "lock_phone": false,
            "lock_email": false,
            "hide_phone": false,
            "blank_phone": false,
            "hide_email": false,
            "blank_email": true,
            "require_selfie_photo": false,
            "require_document_photo": false,
            "selfie_validation_type": "none",
            "qualification": "Aprovador"
        }
    ],
    "inputs": [
        {
            "variable": "{{nome}}",
            "input_type": "input",
            "label": "nome",
            "help_text": "",
            "options": "",
            "required": true,
            "order": 1
        },
        {
            "variable": "{{email}}",
            "input_type": "input",
            "label": "email",
            "help_text": "",
            "options": "",
            "required": true,
            "order": 2
        },
        {
            "variable": "{{numero documento}}",
            "input_type": "input",
            "label": "numero documento",
            "help_text": "",
            "options": "",
            "required": true,
            "order": 3
        },
        {
            "variable": "{{endereco}}",
            "input_type": "input",
            "label": "endereco",
            "help_text": "",
            "options": "",
            "required": true,
            "order": 4
        }
    ],
    "extra_templates": [],
    "notify_extra_emails": "[e-mail]",
    "custom_intro": "",
    "youtube_video_code": ""
}

Próximos Passos

• Se o signatário precisar preencher os campos dinâmicos no formulário durante a assinatura, você deve configurar o formulário usando o endpoint "Configuração de Formulário de Modelo".

Para criar documentos a partir deste modelo, acesse a seção "Criar Documento via Modelo".

---

Sobre Base64

Base64 é uma forma simples de converter arquivos em texto. Se quiser saber mais detalhes sobre o que é Base64, você pode consultar sua definição completa aqui.

Ao converter um arquivo para Base64 e enviá-lo como texto no corpo da requisição, ele se torna mais fácil de manipular do que, por exemplo, o formato multipart/form-data.

Para testar a API, você pode converter manualmente seu arquivo DOCX para Base64 através de diversos sites online, como este.

Quando a API já estiver integrada ao seu sistema, procure a função correspondente na sua linguagem de programação para converter arquivos para Base64.

Atenção: Você deve enviar o parâmetro base64_docx somente com a conversão Base64 do arquivo. Não inclua data:application/pdf;base64, no seu parâmetro.