Firma en lote via API

Batch sign via API

POST https://api.zapsign.com.br/api/v1/sign/

Si alguien de tu empresa necesita firmar muchos documentos en ZapSign, una excelente opción es realizar esta firma de manera programada a través de la API.

Requisitos previos:

1. Solo puedes firmar mediante API con usuarios dentro de tu cuenta. Esto significa que los firmantes deben estar registrados como usuarios en tu cuenta, configurados desde la sección de Ajustes > Organización > Usuarios. No es posible firmar para terceros o clientes externos que no sean usuarios de tu cuenta.

2. Sólo es posible firmar documentos que tienen el correo electrónico del firmante vacío o igual al del usuario que va a firmar los documentos. En caso de ser un correo diferente, no va a ser posible firmar.

3. El usuario debe tener guardada la información de nombre, apellido, teléfono, firma e iniciales en la sección de Ajustes > Mi perfil > Info Personal.

4. La firma vía API no consume créditos (es gratuita). Sin embargo, necesitas tener un Plan API activo para usar este endpoint, incluyendo el add-on de firma en lote.

5. La firma en lote solo funciona con autenticación de "firma en pantalla", selfie y foto de documento de identidad. Si el documento tiene otro método de autenticación, no va a ser posible firmar esos docuemtnos.

Con esta funcionalidad, podrás ahorrar tiempo y hacer que el proceso de firma sea más eficiente para tu equipo. 🚀

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
user_token	string	El token del usuario que va a firmar. La persona debe estar registrada como usuario en tu cuenta de ZapSign y debe compartir contigo su token que se encuentra en Ajustes > Perfil > Seguridad.
signer_tokens[]	array	Token del firmante que se encuentra en la respuesta después de crear un documento.
selfie_photo	string	Debe ser una URL públicamente accesible que contenga la imagen de la selfie, aceptada en los formatos JPG, JPEG o PNG.
document_photo_url	string	Debe ser una URL públicamente accesible que contenga la imagen frontal del documento, aceptada en los formatos JPG, JPEG o PNG.
document_verse_photo_url	string	Debe ser una URL públicamente accesible que contenga la imagen trasera del documento, aceptada en los formatos JPG, JPEG o PNG.

200

400

Request

Sign in batch | ZapSign WorkspacePostman

Response

{"message":"Documento(s) firmados(s) con éxito. Recordatorio: este endpoint es asíncrono, entonces aguarda los PDF firmados en el webhook"}

¿Dónde encuentro el token del usuario?

El usuario debe iniciar en la cuenta de ZapSign y dirigirse a la sección de Ajustes > Mi Perfil > Seguridad y activar el switch al lado de "Firma a través de API". Debe copiar el código alfanúmerico que se muestra en la sección.

¿Cómo obtengo el token del firmante?

Cuando se crea un documento en ZapSign, cada firmante tiene un token asociado. Copia ese token generado por ZapSign que se encuentra en el objeto de Signer, no te confundas con el token del documento.

Nota: si sólo vas a firmar un documento a la vez, sólo inserta un arreglo con un sólo token del firmante (signer_token). Ej: ["123-abc-456-def"]

404 errores

Si intentas hacer una solicitud con un user_token o signer_token que no existen, vas a recibir un error 404 (NOT FOUND). Si esto ocurre, revisa que no estes tomando el token del documento en vez del token del firmante.

400 errores

Si intentas firmar un documento que tiene un método de autenticación no permitido para firma en lote.

Endpoint asíncrono

Este endpoint es asíncrono, lo que significa que puedes enviar la solicitud para que los documentos se firmen y recibirás una respuesta casi inmediata de ZapSign. A medida que los documentos estén listos, tu aplicación irá recibiendo los webhooks uno por uno.