Endpoints
El mapa completo de la API. Todos los endpoints, en dos superficies.
La API se divide en dos superficies, con la misma clave x-api-key para ambas:
| API |
Base URL |
Para qué |
| Facturación |
https://sandbox.veribai.com (TEST) · https://api.veribai.com (LIVE) |
Emitir, corregir y consultar facturas. La base URL es el entorno. |
| Gestión |
https://manage-api.veribai.com |
Emisores, representación, webhooks y validación de NIF. El entorno se detecta automáticamente a partir de la clave. |
API de facturación
Emisión y corrección
| Método |
Endpoint |
Descripción |
POST |
/v1/verifactu/crear |
Alta de registro VeriFactu (AEAT). Referencia |
PUT |
/v1/verifactu/subsanar |
Subsanación de un registro VeriFactu. Referencia |
POST |
/v1/verifactu/anular |
Anulación de un registro VeriFactu. Referencia |
POST |
/v1/ticketbai/crear |
Alta de factura TicketBAI (hacienda foral según provincia). Referencia |
PUT |
/v1/ticketbai/subsanar |
Subsanación de un registro TicketBAI. Referencia |
POST |
/v1/ticketbai/anular |
Anulación de un registro TicketBAI. Referencia |
Consulta
| Método |
Endpoint |
Descripción |
GET |
/v1/cuenta |
Comprueba la clave: entorno, plan y estado de la cuenta. Referencia |
GET |
/v1/facturas |
Listado de facturas de un emisor. Referencia |
GET |
/v1/facturas/buscar |
Localiza una factura por serie, número y fecha. Referencia |
GET |
/v1/facturas/{idFactura} |
Detalle de una factura. |
GET |
/v1/facturas/{idFactura}/estado |
Estado de la remisión (polling). |
GET |
/v1/facturas/{idFactura}/qr |
Código QR (PNG). |
GET |
/v1/facturas/{idFactura}/xml |
XML firmado del registro. |
GET |
/v1/registros |
Listado de registros de facturación. |
GET |
/v1/registros/{idRegistro} |
Detalle de un registro. |
API de gestión
Validación de NIF
| Método |
Endpoint |
Descripción |
POST |
/v1/nif/validar |
Valida NIF y nombre contra el censo de la AEAT, antes de emitir. Referencia |
Clientes (emisores)
| Método |
Endpoint |
Descripción |
GET |
/v1/clientes |
Listado de emisores y plazas del plan. Referencia |
POST |
/v1/clientes/crear |
Alta de un emisor. |
GET |
/v1/clientes/{nif} |
Detalle. |
PATCH |
/v1/clientes/{nif} |
Modificación parcial. |
PATCH |
/v1/clientes/{nif}/estado |
Activar o desactivar. |
Dispositivos (Alta capacidad)
Solo para emisores con el modo de alta capacidad contratado.
| Método |
Endpoint |
Descripción |
GET / POST |
/v1/clientes/{nif}/dispositivos |
Listado / alta de dispositivos. Referencia |
DELETE |
/v1/clientes/{nif}/dispositivos/{idMaquina} |
Baja de un dispositivo. |
POST |
/v1/clientes/{nif}/dispositivos/promover |
Copia a LIVE los dispositivos de TEST. |
POST |
/v1/clientes/{nif}/dispositivos/solicitar-activacion |
Avisa de que la preparación de Alta capacidad está hecha. |
POST |
/v1/clientes/{nif}/dispositivos/series-centralizadas |
Reserva series para el envío centralizado. |
DELETE |
/v1/clientes/{nif}/dispositivos/series-centralizadas/{serie} |
Libera una reserva. |
Representación
| Método |
Endpoint |
Descripción |
GET |
/v1/clientes/{nif}/representacion/generar |
Genera el documento sin firmar. Referencia |
POST |
/v1/clientes/{nif}/representacion/firmar |
Firma en la nube con certificado .p12. |
POST |
/v1/clientes/{nif}/representacion/verificar |
Sube el documento firmado externamente. |
GET |
/v1/clientes/{nif}/representacion/estado |
Estado de la representación. |
DELETE |
/v1/clientes/{nif}/representacion/firma-en-curso |
Cancela una firma en curso. |
Webhooks
| Método |
Endpoint |
Descripción |
GET / POST |
/v1/webhooks |
Listado / creación. Referencia |
GET / PATCH / DELETE |
/v1/webhooks/{idWebhook} |
Detalle, modificación, borrado. |
GET / POST |
/v1/webhooks/{idWebhook}/clientes |
Emisores vinculados / vincular. |
DELETE |
/v1/webhooks/{idWebhook}/clientes/{nif} |
Desvincular un emisor. |
Cumplimiento
| Método |
Endpoint |
Descripción |
GET |
/v1/cumplimiento/declaracion-responsable |
URL de la Declaración Responsable vigente. Referencia |
Convenciones comunes (formatos, importes, paginación, límites) en Límites y convenciones. Formato y códigos de error en Errores.