Referencia de API
Crear un documento
El endpoint principal.
Eliminar un documento
Elimina un documento y descarta sus notificaciones pendientes.
Restaurar un documento
Reactiva un documento eliminado.
Suscribirse a un evento
Registra una URL para recibir aviso cuando ocurra un evento.
Cancelar la suscripción a un evento
Elimina una suscripción por su id.
Consultar los paquetes restantes
Devuelve lo que queda de los paquetes contratados.
Consultar el detalle de paquetes
Devuelve los paquetes de la cuenta uno por uno — cuántas piezas trae cada uno, cuántas ya se usaron y la ventana en la que es válido.
Consultar el reporte de consumo
Devuelve lo que consumió la cuenta entre dos fechas — documentos creados, verificaciones realizadas, mensajes enviados — para conciliación y cobro interno.
Un firmante firmó el documento
Se dispara cada vez que alguien firma.
Se encapsuló una firma
Se dispara cuando la firma ya se envolvió en la representación universal de validación a largo plazo.
Ya se firmaron todos los recuadros
El evento sobre el que conviene construir tu lógica de negocio: el documento ya está completamente firmado y listo para descargar con `GET /api/document/{type}/{ticket}`.
Un firmante rechazó el documento
`meta` trae quién lo rechazó y el motivo que dio, hasta 300 caracteres.
El flujo de firma expiró
El flujo llegó a su `expirationDate` con firmas todavía pendientes.
No se pudo entregar un mensaje de WhatsApp
El firmante nunca recibió su invitación.
No se pudo entregar un SMS
Misma forma y los mismos códigos que `whatsapp_error`.
No se pudo entregar un correo
`meta` transmite lo que respondió el servidor de correo receptor, para que distingas un correo mal escrito de un buzón lleno.
El documento original se selló con NOM-151
`meta` trae el sello mismo.
El documento universal se selló con NOM-151
Misma forma que `original_nom151_stamped`, para la representación universal.
Una verificación de identidad no pasó
Se manda para firmantes con `requireIdentityVerification`.
Una verificación de identidad pasó
Se confirmó la identidad del firmante y ya puede firmar.
Sellar un hash
Emite un sello de tiempo NOM-151 sobre un hash cualquiera — no hace falta un documento.
Validar un sello de tiempo
Comprueba un sello NOM-151 contra los datos que dice amparar.
Sellar un PDF con NOM-151
Aplica un sello de tiempo NOM-151 a un PDF que ya tienes y devuelve el archivo sellado — para documentos firmados fuera de Firmame, o PDFs ya firmados a los que hay que agregarles el sello.
Validar el sello NOM-151 de un PDF
Verifica el sello NOM-151 embebido en un PDF: que el token sea genuino, que lo haya emitido una autoridad reconocida, y que el documento no haya cambiado desde entonces.
Aplanar un PDF
Devuelve una versión aplanada del PDF — los campos de formulario se vuelven contenido estático, las capas se fusionan, y el resultado es un PDF imprimible simple.
Obtener las dimensiones de una página
Devuelve el tamaño y la rotación de una página, para que calcules los rectángulos de los stickers y caigan donde esperas en vez de adivinar entre Carta y A4.
Descargar un documento firmado
Descarga el PDF firmado, codificado en Base64 dentro de un sobre JSON, junto con su hash.
Listar los sellos NOM-151 de un documento
Devuelve todos los sellos de tiempo NOM-151 aplicados al documento, cada uno con la autoridad que lo emitió, cuándo se emitió, y el token mismo.
Descargar la revisión que ampara un sello
Devuelve la revisión exacta del documento sobre la que se aplicó un sello NOM-151 — los bytes cuyo hash certifica el sello.
Obtener los datos de un correo certificado
Devuelve la evidencia de un correo certificado — a quién se envió, cuándo se entregó, cuándo se abrió, y el contenido que se mandó.
Listar documentos
Lista los documentos creados en una ventana de tiempo, del más reciente al más viejo.
Obtener el reporte de firmas de un documento
Devuelve el reporte forense completo del documento: cada firma con su posición, su cadena de certificados, su estado OCSP, su autoridad de sellado de tiempo, y si sigue siendo válida.
Obtener el historial de un documento
El historial de un documento contiene información de la generación de un documento, envío, seguimiento y firmas.
Descargar el historial de un documento en PDF
El mismo historial que [`GET /api/v1/document/{frmxId}/history/json`](/docs/api/consultas/get-document-history), pero como PDF listo para entregárselo a alguien.
Obtener un documento desde una notificación de webhook
Convierte el `notification_id` de un webhook en el documento mismo.
Crear un expediente
Crea un expediente vacío y devuelve su id.
Consultar un expediente
Devuelve los documentos, los firmantes y el estado del expediente.
Cerrar un expediente y arrancar su flujo
Sella el expediente —ya no se le agregan documentos— y arranca el flujo de firma sobre todos los documentos que contiene.
Agregar un firmante al expediente
Precarga un firmante para todo el expediente, sin ligarlo todavía a una página o posición.
Quitar un firmante del expediente
Elimina un firmante agregado antes con `POST /api/documentset/{uuid}/signer`.
Crear o editar el flujo de un documento
Le pone un flujo de firma a un documento existente, cambia el que ya tiene, o lo cancela.
Crear o editar el flujo de un expediente
Ajusta el flujo de un expediente que ya cerraste: su expiración, cada cuánto insiste, qué lleva el correo de conclusión, o su cancelación.
Editar un firmante
Corrige los datos de un firmante **antes de que haya firmado** — un correo mal escrito, el dato de verificación equivocado, o un cambio de autoridad.
Endosar un documento
Agrega un endoso a un documento **completamente firmado** — el equivalente electrónico de endosar un pagaré.
Listar templates
Devuelve todas las plantillas guardadas en la cuenta dueña del web ID que firmó la petición.
Obtener los campos de un template
Devuelve los campos que espera una plantilla, para que armes el payload de `POST /developers/json` sin adivinar los nombres de los placeholders.
Dar de alta un template
Registra una plantilla en tu cuenta, o la reemplaza si ya existe una con el mismo nombre.
Dar de alta un template PDF desde bytes
Igual que `POST /developers/template/save`, pero el cuerpo es el PDF crudo en vez de JSON — útil cuando el archivo es lo bastante grande como para que pese el sobrecosto de Base64.