Skip to content

Endpoints ​

Los endpoints de comprobantes requieren Authorization: Bearer <api-key> y X-Issuer-Id: <issuer-id>. La configuración del tenant, la gestión de emisores y la gestión de llaves solo requieren Authorization: Bearer <api-key>. La creación, recuperación y activación de cuentas están restringidas a la aplicación web de Comprobify — ver abajo.

Run in Postman

Cuenta, acuerdos legales y promoción a producción (solo aplicación web) ​

Crear la cuenta, verificar el correo, recuperar el acceso, aceptar los acuerdos legales y pasar a producción se hacen en la aplicación web de Comprobify, no por API — ver Tu cuenta y la aplicación web.

¿Cómo pagas tu suscripción? Desde la aplicación web — con tarjeta o transferencia bancaria, incluyendo consultar los planes y precios vigentes. No hay endpoints públicos que integrar para nada de esto; ver Tu suscripción y cómo pagarla.

Tenants (autenticado) ​

MétodoRutaDescripción
GET/v1/tenants/meResuelve el tenant (id, correo, plan, estado, cuota, entorno, aceptación de acuerdos) para la API key autenticada
PATCH/v1/tenants/languageActualiza el idioma preferido para los correos salientes
GET/v1/tenants/eventsBitácora de auditoría completa a nivel de tenant (verificación, suscripción, pagos, historial de cambios de plan/intervalo de facturación), en orden cronológico
POST/v1/tenants/retry-failed-documentsRecupera todos los comprobantes estancados del tenant (envío/autorización fallidos tras agotar los reintentos automáticos) — abarca todos los emisores, sin X-Issuer-Id (Reintentar Todos los Comprobantes Fallidos)

Emisores (autenticado) ​

MétodoRutaDescripción
GET/v1/issuersLista todos los emisores activos (sucursales / puntos de emisión) del tenant
POST/v1/issuersCrea una nueva sucursal o punto de emisión — hereda el certificado de un emisor existente del tenant. NO genera una nueva API key.
GET/v1/issuers/:idObtiene el perfil de un emisor (nombre, RUC, vencimiento del certificado)
PATCH/v1/issuers/:idEdita tradeName y/o branchAddress
DELETE/v1/issuers/:idElimina (soft-delete) un emisor (bloqueado si es el último o si ya emitió comprobantes)
PATCH/v1/issuers/:id/activateReactiva un emisor eliminado (soft-delete) (vuelve a verificar los límites de sucursales/puntos de emisión del plan)
PATCH/v1/issuers/:id/can-issuePausa o reanuda la creación de comprobantes nuevos en el emisor, sin desactivarlo
PATCH/v1/issuers/:id/logoSube o reemplaza el logo del emisor mostrado en los PDF RIDE (PNG/JPEG/GIF, máx. 500 KB)
PATCH/v1/issuers/:id/certificateRenueva el certificado P12 del emisor (llave privada + certificado) — por ejemplo, cuando ha vencido
GET/v1/issuers/:id/document-typesLista los tipos de comprobante activos para el emisor
POST/v1/issuers/:id/document-typesHabilita un tipo de comprobante para el emisor
DELETE/v1/issuers/:id/document-types/:codeDeshabilita un tipo de comprobante para el emisor
GET/v1/issuers/:id/sequentialsConsulta los números secuenciales actuales y siguientes por tipo de comprobante, por entorno
PATCH/v1/issuers/:id/sequentials/:documentTypeEstablece manualmente el siguiente número secuencial para un tipo de comprobante/entorno

API keys (autenticado) ​

MétodoRutaDescripción
GET/v1/keysLista todas las llaves activas del tenant (etiqueta, entorno, created_at, uso)
POST/v1/keysGenera una nueva llave con nombre (label, environment opcional)
DELETE/v1/keys/:idRevoca una API key. No se puede revocar la llave usada en la solicitud actual.
GET/v1/keys/:id/usageSerie diaria de uso de una llave, rellenada con ceros, lista para graficar

Comprobantes ​

Cada endpoint de comprobantes requiere tanto Authorization: Bearer <key> como X-Issuer-Id: <issuer-id>.

MétodoRutaDescripción
GET/v1/documentsLista comprobantes con filtros y paginación
GET/v1/documents/statsEstadísticas de comprobantes por tipo del mes actual + cantidad que requiere atención
POST/v1/documentsCrea y firma un comprobante — factura (Create Invoice) o nota de crédito (Create Credit Note), seleccionado mediante documentType
GET/v1/documents/:accessKeyObtiene un comprobante por clave de acceso
POST/v1/documents/:accessKey/sendEncola el envío al SRI (Send to SRI — devuelve 202, asíncrono)
POST/v1/documents/:accessKey/send/retryRecupera un comprobante estancado tras agotar los reintentos automáticos de envío/autorización (Reintentar Envío/Autorización — devuelve 202, asíncrono)
GET/v1/documents/:accessKey/authorizeEncola una verificación de autorización ante el SRI (Check Authorization — devuelve 202, asíncrono)
POST/v1/documents/:accessKey/rebuildReconstruye y vuelve a firmar un comprobante rechazado
POST/v1/documents/:accessKey/voidAnula un comprobante AUTHORIZED (Anular Comprobante — sincronización manual, no llama al SRI)
GET/v1/documents/:accessKey/rideDescarga el PDF RIDE
GET/v1/documents/:accessKey/xmlDescarga el XML firmado
GET/v1/documents/:accessKey/eventsObtiene el historial de eventos de auditoría
GET/v1/documents/:accessKey/sri-responsesResultados sin procesar de las llamadas de recepción/autorización al SRI (estado + mensajes) para este comprobante
GET/v1/documents/:accessKey/credit-notesSuma de notas de crédito AUTHORIZED emitidas contra este comprobante + saldo restante
POST/v1/documents/email-retryReintenta todos los correos fallidos/pendientes (por lote)
POST/v1/documents/:accessKey/email-retryReintenta el correo de un solo comprobante

Notificaciones (autenticado) ​

Alertas a nivel de tenant para eventos de comprobantes y estado de certificados. Proporciona X-Issuer-Id para filtrar por un emisor específico; omítelo para recibir notificaciones de todos tus emisores. Usa ?sinceId=<id> para consultar de forma eficiente solo las notificaciones nuevas desde tu última solicitud.

MétodoRutaDescripción
GET/v1/notificationsLista notificaciones activas (leídas y no leídas). ?sinceId=<id> opcional para consultas de actualización incremental.
POST/v1/notifications/:id/readMarca una notificación como leída
GET/v1/notifications/preferencesObtiene las preferencias de tipo de notificación del tenant
PATCH/v1/notifications/preferencesHabilita o deshabilita tipos de notificación

Webhooks (autenticado) ​

Registra URLs de callback HTTPS para recibir notificaciones de eventos casi en tiempo real.

MétodoRutaDescripción
POST/v1/webhooksRegistra un nuevo endpoint de webhook (el secreto se muestra una sola vez)
GET/v1/webhooksLista los endpoints de webhook activos (sin incluir los secretos)
PATCH/v1/webhooks/:idActualiza la URL, las suscripciones a eventos o el indicador de activo
DELETE/v1/webhooks/:idDa de baja un endpoint (soft-delete)

Monitoreo ​

MétodoRutaAutenticaciónDescripción
GET/healthNingunaVerificación de conectividad a la base de datos para sondas de liveness

Documentación de la API de Comprobify — API v1.3.1