Firma en lote via API
Si su empresa necesita firmar con frecuencia muchos documentos, este endpoint ofrece una manera eficiente de realizar esas firmas sin tener que acceder manualmente a cada documento. ¡Con la firma en lote, ahorra tiempo y automatiza el proceso de firma de múltiples documentos!
Firmar en lote via API:
POST https://api.zapsign.com.br/api/v1/sign/
En esta sección:
Requisitos previos:
Solo puede firmar vía API con usuarios dentro de su cuenta.
Esto significa que los firmantes deben estar registrados como usuarios en su cuenta, configurados en la sección Ajustes > Organización > Usuarios. No es posible firmar en nombre de terceros o clientes externos que no sean usuarios de su cuenta.
Solo es posible firmar documentos que tengan el correo electrónico del firmante vacío o igual al del usuario que está firmando los documentos. Si el correo es diferente, no será posible firmar.
El usuario debe tener la siguiente información guardada en la sección Ajustes > Mi perfil > Info Personal: nombre, apellido, teléfono, firma y visto.
La firma vía API no consume créditos (es gratuita).
Sin embargo, es necesario tener el Plan API activo y el add-on de firma en lote.
Autenticación soportada:
Autenticación estándar:
La firma en lote solo funciona con la autenticación estándar: "firma en pantalla".
Autenticaciones avanzadas (opcionales – si se seleccionan en la creación del documento):
"Selfie"
Cuando esta opción esté seleccionada en la creación del documento, es obligatorio enviar el campo "selfie_photo" en el body de la solicitud.
"Foto del documento de identidad"
Al seleccionar esta opción en la creación del documento, es obligatorio enviar los campos "document_photo_url" y "document_verse_photo_url".
Si el documento tiene cualquier otro método de autenticación avanzada no listado arriba, no será posible firmar dichos documentos.
Encabezado
Authorization*
string
API token prefijo con la palabra "Bearer". Ex: Bearer c7f35c84-7893-4087-b4fb-d1f06c23
Request Body
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.
{"message":"Documento(s) firmados(s) con éxito. Recordatorio: este endpoint es asíncrono, entonces aguarda los PDF firmados en el webhook"}Request
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.
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.
Last updated
Was this helpful?