Referencia de la API
La referencia completa —cuerpos, respuestas, códigos de error y un cliente para probar llamadas— se genera desde el propio código de la API y se publica con ella.
Referencia interactiva
https://verifactu-api.zctechpartners.cloud/docs es la referencia OpenAPI interactiva. La especificación en JSON está en https://verifactu-api.zctechpartners.cloud/openapi.json: úsala para generar un cliente en tu lenguaje o para validar cuerpos en desarrollo.
Endpoints
Todos bajo https://verifactu-api.zctechpartners.cloud/v1, autenticados con clave. La última columna es la capacidad que la clave necesita; el perfil integración incluye facturas:emitir, registros:leer, registros:reprocesar, obligados:leer y webhooks:leer.
| Método | Ruta | Qué hace | Capacidad |
|---|---|---|---|
POST | /facturas | Emitir una factura (registro de alta encadenado) | facturas:emitir |
GET | /facturas | Listar registros de alta | registros:leer |
GET | /facturas/{id} | Un registro de alta con su estado de remisión e historial | registros:leer |
POST | /anulaciones | Anular una factura (registro de anulación) | facturas:emitir |
GET | /anulaciones/{id} | Un registro de anulación | registros:leer |
GET | /registros | Listar altas y anulaciones con filtros y paginación; format=export para inspección | registros:leer |
GET | /registros/{id} | Un registro, del tipo que sea | registros:leer |
GET | /registros/{id}/qr | QR de cotejo renderizado (SVG) | registros:leer |
POST | /registros/{id}/reenvio | Reencolar un registro con envío agotado | registros:reprocesar |
POST | /registros/{id}/subsanacion | Emitir la subsanación de un registro rechazado — todavía no disponible: responde 501 | registros:reprocesar |
POST | /consultas | Consultar a la AEAT los registros de un obligado (conciliación) — todavía no disponible: responde 501 | registros:leer |
GET · POST | /obligados | Listar / dar de alta obligados | obligados:leer · obligados:escribir |
GET · PATCH | /obligados/{id} | Consultar / actualizar datos seguros de un obligado | obligados:leer · obligados:escribir |
PUT · DELETE | /obligados/{id}/certificado | Cargar / revocar el certificado (vía propia) | certificados:gestionar |
GET · POST | /obligados/{id}/series | Listar / crear series | obligados:leer · obligados:escribir |
GET · POST | /webhooks | Listar / crear suscripciones | webhooks:leer · webhooks:gestionar |
DELETE | /webhooks/{id} | Eliminar una suscripción | webhooks:gestionar |
GET · POST | /apikeys | Listar / crear claves | apikeys:leer · apikeys:gestionar |
DELETE | /apikeys/{id} | Revocar una clave | apikeys:gestionar |
Rutas públicas
| Ruta | Qué es |
|---|---|
GET /health | Sonda de salud: versión desplegada, región y estado de la base de datos. |
GET /sif | Identidad del sistema informático de facturación (productor, nombre, versión) y enlaces a la declaración. |
GET /sif/declaracion | Declaración responsable de la versión en producción (markdown). /sif/declaracion.json, con metadatos. |
GET /openapi.json · GET /docs | Especificación OpenAPI y referencia interactiva. |