Crear plantilla DOCX

Las plantillas DOCX en ZapSign permiten la automatización de documentos con campos dinámicos, facilitando la generación de contratos, acuerdos y otros documentos recurrentes. Crear documentos a partir de una plantilla es útil para varios casos de uso como:

  • Enviar un documento al firmante para que complete un formulario y con esa información crear el documento. Por ejemplo: solicitud de póliza de seguro, consentimiento informado, inscripciones a eventos, entre otros.

  • Enviar el documento al firmante con la información parcialmente llena para que complete el formulario y los campos faltantes. El documento se creará con los campos dinámicos y el firmante continuará con el proceso de firma. Por ejemplo: apertura de cuentas bancarias, solicitud de préstamo.

  • Llenar todos los campos dinámicos para crear el documento final y el firmante sólo debe firmar el documento. Por ejemplo: contrato laboral, pagaré, contrato de arriendo.

Creación del documento en Word (DOCX)

Antes de utilizar el endpoint para crear una plantilla en ZapSign, es necesario preparar el archivo DOCX con los campos dinámicos que se reemplazarán con información específica en cada generación de documento. Para ello, sigue estos pasos:

  1. Crear el documento base

    • Utiliza Microsoft Word, Google Docs (exportando a DOCX) o cualquier editor compatible con el formato DOCX.

    • Redacta el contenido del documento asegurándote de estructurarlo correctamente.

  2. Definir los campos dinámicos

    • Los campos dinámicos se representan con llaves dobles {{campo}} dentro del documento.

    • Ejemplo: {{nombre}}, {{fecha}}, {{email}}.

  3. Evitar imágenes y tablas

    1. Te recomendamos evitar el uso de imágenes y tablas en el documento DOCX, porque puede interferir con el correcto uso de la funcionalidad.

  4. Guardar y exportar

    • Guarda el archivo en formato .docx.

    • Verifica que los campos dinámicos estén correctamente escritos y ubicados.

Una vez que el documento DOCX esté preparado, se podrá utilizar el endpoint correspondiente para subir la plantilla a ZapSign y comenzar a generar documentos de manera automatizada.

Crear plantilla DOCX

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

Encabezado

Nombre
Tipo
Descripción

Authorization*

string

API token prefijo con la palabra "Bearer". Ex: Bearer c7f35c84-7893-4087-b4fb-d1f06c23

Request Body

Nombre
Tipo
Descripción

name

string

Título de la plantilla máximo 255 caracteres.

url_docx

string

Debe ser una URL pública y el tamaño del documento máximo 10Mb.

base64_docx

string

Documento convertido a cadena de base64.

lang

string

Idioma del documento Posibles valores: "pt-br" (Portugues), "es" (Español), "en" (Inglés), "fr" (Francés).

Valor por defecto: "pt-br"

observers

array<string>

Representa a los observadores del documento (hasta 20 personas), es decir, direcciones de correo electrónico que serán notificadas cuando se firme un documento generado a partir de esta plantilla. Es un array de correos electrónicos.

first_signer

Objeto

Configuración del firmante del documento.

Configurando el firmante

Estos campos permiten ajustar la experiencia de firma cómo el método de autenticación.

Los datos del firmante (nombre, correo electrónico) se definen al crear el documento a partir de una plantilla

first_signer

  • blank_email (boolean): Si se establece en true, no se solicitará el correo electrónico del firmante y no se incluirá en el informe de la firma. Es obligatorio tener el correo O el número de teléfono del firmante. Default false

  • blank_phone (boolean): Si se establece en true, no se solicitará el celular del firmante y no se incluirá en el informe de la firma. Es obligatorio tener el correo O el número de teléfono del firmante. Default false

  • qualification (string): Rol del firmante que se mostrará en el informe de firma. Por ejemplo "Testigo" se mostrará como "Firmo como Testigo". Por defecto "".

  • auth_mode (string): Elige el método de autenticación para el firmante. Esto adiciona más seguridad al documento firmado, para más información sobre los métodos haz clic aqui. Default "assinaturaTela"

auth_mode
Descripción
Costo adicional

"assinaturaTela"

Firma en pantalla

Gratis

"tokenEmail"

Validación del correo con un código enviado por correo

Gratis

"assinaturaTela-tokenEmail"

Firma en pantalla y validación del correo con un código enviado por correo

Gratis

"tokenSms"

Validación del celular con un código enviado por SMS

Gratis

"assinaturaTela-tokenSms"

Firma en pantalla y validación del celular con un código enviado por SMS

Gratis

"tokenWhatsapp"

Validación del celular con un código enviado por WhatsApp

5 credis = USD$0.1

"assinaturaTela-tokenWhatsapp"

Firma en pantalla y validación del celular con un código enviado por WhatsApp

5 creditos = USD$0.1

  • require_selfie_photo (boolean): Si se establece en true, se pedirá al firmante que tome una selfie durante el proceso de firma (no hay validación de la foto). Por defecto es false.

  • require_document_photo (boolean): Si se establece en true, se pedirá al firmante que tome una foto del frente y anverso del documento de identidad durante el proceso de firma (no hay validación de la foto). Por defecto es false.

  • selfie_validation_type (string): Métodos biométricos avanzados para validar la identidad del firmante. Para conocer más sobre cada método haz clic aqui.

selfie_validation_type
Descripción
Países
Precio

liveness-document-match

Reconocimiento facial que valida que el firmante esté presente y sea el mismo que la foto del documento suministrada.

CO, BR, MX, CL, PE

24 créditos = $0.48 USD

identity-verification

Validación del documento y biometría facial, asegurando que el firmante esté presente, que el documento sea real y que esté registrado en bases de datos gubernamentales.

CO, MX, CL, PE

55 créditos = $1.0 USD

identity-verification-global

Validación del documento y biometría facial, garantizando que el firmante esté presente, que el documento sea auténtico (mediante modelos de detección de fraude) y que el nombre extraído del documento coincida con el del firmante. Nota: no incluye validación en bases de datos gubernamentales

Global

50 créditos = $0.9 USD

liveness-NXCD

Valida que la persona está presente en el momento de la firma con un vídeo pasivo (liveness)

Global

15 créditos = $0.3USD

Solicitud

{
    "name": "Nombre de la plantilla",
    "docx_url": "https://zapsign.s3.amazonaws.com/dev/2025/1/docs/1b1e8e16-b9ce-45f4-8dc8-c0320af371a5/29812f55-eb17-4182-b65e-09e895a861ad.docx",
    "lang": "es",
    "observers": [
        "email@email.com"
    ],
    "first_signer": {
        "blank_email": false,
        "blank_phone": false,
        "auth_mode": "assinaturaTela",
        "require_selfie_photo": false,
        "require_document_photo": false,
        "selfie_validation_type": "",
        "qualification": "Representante Legal"
    }
}

Respuesta

Después de una solicitud exitosa, recibirás una respuesta similar a esta:

{
    "token": "272xxxd4-ecda-47xx2-be7e-59e2beb752xx",
    "template_type": "docx",
    "name": "Nombre de la plantilla",
    "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": "es",
    "signers": [
        {
            "name": "Firmante 1",
            "auth_mode": "assinaturaTela",
            "email": "",
            "phone_country": "57",
            "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": "Representante Legal"
        }
    ],
    "inputs": [
        {
            "variable": "{nombre}}",
            "input_type": "input",
            "label": "nombre",
            "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": "{{direccion}}",
            "input_type": "input",
            "label": "direccion",
            "help_text": "",
            "options": "",
            "required": true,
            "order": 4
        }
    ],
    "extra_templates": [],
    "notify_extra_emails": "email@email.com",
    "custom_intro": "",
    "youtube_video_code": ""
}

Próximos pasos

Si el firmante va a completar los campos dinámicos en el formulario durante la firma, debes configurar el formulario con el endpoint "Configuración formulario plantilla"

Para crear documentos a partir de ésta plantilla ve a la sección "Crear documento via plantilla"

Sobre base64

Base64 es una forma sencilla de convertir archivos en texto. Si quieres conocer más detalles sobre qué es Base64, puedes consultar su definición completa aquí. Al convertir un archivo a Base64 y enviarlo como texto en el cuerpo de la solicitud, es más fácil de manejar que, por ejemplo, el formato multipart/form-data.

Para probar la API, puedes convertir tu archivo DOCX a Base64 manualmente a través de varios sitios web, como este.

Cuando ya tengas la API integrada en tu sistema, busca la función correspondiente en tu lenguaje de programación para convertir archivos a Base64.

¡Atención! Debes enviar el parámetro base64_docx solo con la conversión Base64 del archivo. No incluyas data:application/pdf;base64, en tu parámetro.

PreviousRechazar documentos por el usuarioNextConfigurar formulario de plantilla

Last updated

Was this helpful?