> ## Documentation Index > Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt > Use this file to discover all available pages before exploring further. # Obtener disponibilidad del servicio > Prerrequisito: un certificado activo (ver rotateCertificate, activateCertificate) antes de que la disponibilidad reporte READY; un reporte de disponibilidad READY es a su vez el prerrequisito de una prueba de conectividad (ver createConnectivityTest) y de cualquier operación de envío (ver createBankTransferOperation). Devuelve el resumen de disponibilidad operativa del servicio, incluyendo la conectividad de base de datos, la ventana de validez del certificado, el binding de ajustes de canal y cualquier subsistema degradado. Lo usan los dashboards de operaciones y las compuertas previas antes del envío al STR. Independiente de la prueba global /readyz de Kubernetes: este endpoint reporta el estado de disponibilidad operativa del participante, mientras que /readyz reporta la salud de dependencias a nivel de proceso. ## OpenAPI ````yaml es/openapi/v3-current/spb.yaml get /v1/str/readiness openapi: 3.1.0 info: contact: email: contact@lerian.studio name: Lerian Studio url: https://lerian.studio description: >- Interfaz OpenAPI 3.1 de Lerian SPB, la integración directa entre la institución y el Sistema de Pagos Brasileño (SPB) sobre la Red del Sistema Financiero Nacional (RSFN). Cubre el Sistema de Transferencia de Reservas (STR): registro de mensajes y catálogo de capacidades, ciclo de vida de las operaciones (transferencias bancarias, repasses IBS, transferencias de liquidez, devoluciones y cancelaciones), consultas de cuenta de reservas y de horarios, gobernanza de alçada, conciliación y entrega de eventos. license: name: Lerian Studio General License title: Lerian SPB API version: 1.0.0 servers: - url: https://spb.sandbox.lerian.net security: [] tags: - description: >- Rastros inmutables de registros de auditoría para operaciones STR y eventos de ciclo de vida. name: Audit - description: >- Catálogo de capacidades STR que describe los tipos de mensaje admitidos y sus restricciones. name: Capabilities - description: >- Inventario de certificados ICP-Brasil con rotación y activación recargables en caliente. name: Certificates - description: >- Cola de aprobación maker-checker para emisiones retenidas por encima de su banda de alçada: listar pendientes, firmar (aprobar) y denegar. name: EmissionApprovals - description: >- Registros de entrega de eventos por webhook con control de reintentos para despachos fallidos. name: EventDeliveries - description: >- Catálogo de eventos de operación que enumera los tipos de evento de dominio emitidos. name: Events - description: >- Registro de avisos entrantes de la familia GEN (GEN0001 eco de conectividad, GEN0004 error de transmisión, GEN0005 aviso administrativo). name: GenNotices - description: >- Gobernanza de alçada del SPB: la tabla de bandas de valor y los requisitos de firma por tipo de mensaje, recargados en caliente en tiempo de ejecución. name: Governance - description: >- Estado crudo de los mensajes STR: listar los mensajes y leer un mensaje individual por NUOp. name: Messages - description: Resúmenes y métricas operativas agregadas de las operaciones STR. name: OperationalIntelligence - description: >- Ciclo de vida de las operaciones STR para transferencias bancarias y repasses IBS, incluyendo devoluciones y cancelaciones. name: Operations - description: >- Estado de disponibilidad del servicio que abarca las autopruebas de arranque y la salud de las dependencias. name: Readiness - description: >- Casos de conciliación y las acciones que resuelven las discrepancias de operación. name: Reconciliation - description: >- Suite de reportes STR: reportes agregados síncronos por rango de fechas (movimiento financiero, transacciones rechazadas, volumetria) sobre el propio registro de transmisión de Lerian SPB. name: Reports - description: >- Consultas de saldo de cuenta de reservas STR0013 y de extrato STR0014 (modo mensaje) y sus resultados asíncronos. name: ReserveQueries - description: >- Lista de responsáveis del participante GEN0019: actualizaciones de reemplazo total anunciadas a BACEN. name: Responsibles - description: >- Programación de ventanas de operación del STR que rige cuándo pueden enviarse las operaciones. name: Schedule - description: >- Consultas de horarios STR0001 de parte única (consulta de horários do STR) y sus resultados de grilla STR0001R1 asíncronos. name: ScheduleQueries - description: >- Ajustes de configuración del SPB en tiempo de ejecución para la integración STR. name: Settings - description: Registro y gestión de endpoints de webhook para la entrega de eventos. name: Webhooks - description: >- Flujo (orden obligatorio): certificado → disponibilidad → prueba-de-conectividad → envío. Activa un certificado, confirma que el rail reporta listo, pasa una prueba de conectividad y luego envía una operación. Cada paso es su propio recurso; no debes intentar un envío antes de que la disponibilidad pase. name: onboarding - description: >- Flujo (orden obligatorio): operación padre SETTLED → devolución/cancelación. Una devolución o cancelación es un sub-recurso de una operación padre liquidada; el segmento de ruta {operationId}/{endToEndID} impone el padre estructuralmente. name: lifecycle paths: /v1/str/readiness: get: tags: - Readiness - onboarding summary: Obtener disponibilidad del servicio description: >- Prerrequisito: un certificado activo (ver rotateCertificate, activateCertificate) antes de que la disponibilidad reporte READY; un reporte de disponibilidad READY es a su vez el prerrequisito de una prueba de conectividad (ver createConnectivityTest) y de cualquier operación de envío (ver createBankTransferOperation). Devuelve el resumen de disponibilidad operativa del servicio, incluyendo la conectividad de base de datos, la ventana de validez del certificado, el binding de ajustes de canal y cualquier subsistema degradado. Lo usan los dashboards de operaciones y las compuertas previas antes del envío al STR. Independiente de la prueba global /readyz de Kubernetes: este endpoint reporta el estado de disponibilidad operativa del participante, mientras que /readyz reporta la salud de dependencias a nivel de proceso. operationId: getReadiness responses: '200': content: application/json: schema: $ref: '#/components/schemas/ReadinessResponse' description: OK links: prerequisite: description: >- Onboarding prerequisite: an active certificate (rotated via rotateCertificate, activated via activateCertificate) is required before readiness reports READY. operationId: rotateCertificate default: content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Error security: - BearerAuth: [] components: schemas: ReadinessResponse: additionalProperties: false properties: checks: description: Per-subsystem readiness checks that compose the aggregate status. items: $ref: '#/components/schemas/ReadinessCheckResponse' type: - array - 'null' correlationId: description: >- Request-scoped correlation identifier echoing X-Request-ID, for pivoting from response to trace. examples: - req-7a3f9c2e type: string status: description: Aggregate readiness status derived from all individual checks. examples: - READY type: string updatedAt: description: RFC3339 UTC timestamp when the readiness snapshot was produced. examples: - '2026-05-04T18:30:00Z' format: date-time type: string required: - status - checks - updatedAt - correlationId type: object Detail: additionalProperties: false properties: code: description: >- Stable, machine-readable domain error code scoped to the emitting service (format: -NNNN). examples: - ERR-0001 type: string detail: description: >- A human-readable explanation specific to this occurrence of the problem. examples: - Property foo is required but is missing. type: string errors: description: Optional list of individual error details items: $ref: '#/components/schemas/ErrorDetail' type: - array - 'null' instance: description: >- A URI reference that identifies the specific occurrence of the problem. examples: - https://example.com/error-log/abc123 format: uri type: string status: description: HTTP status code examples: - 400 format: int64 type: integer title: description: >- A short, human-readable summary of the problem type. This value should not change between occurrences of the error. examples: - Bad Request type: string type: default: about:blank description: A URI reference to human-readable documentation for the error. examples: - https://example.com/errors/example format: uri type: string type: object ReadinessCheckResponse: additionalProperties: false properties: message: description: Human-readable explanation of the check's current state. examples: - certificate valid for 45 days type: string name: description: Name of the readiness check (e.g. certificate, database). examples: - certificate type: string severity: description: >- Impact severity of the check's current state: INFO, WARN, or BLOCKER. examples: - INFO type: string status: description: Readiness status of this individual check. examples: - READY type: string updatedAt: description: RFC3339 UTC timestamp when this check was last evaluated. examples: - '2026-05-04T18:30:00Z' format: date-time type: string required: - name - status - severity - message - updatedAt type: object ErrorDetail: additionalProperties: false properties: location: description: >- Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id' type: string message: description: Error message text type: string value: description: The value at the given location type: object securitySchemes: BearerAuth: bearerFormat: JWT description: JWT bearer token issued by the identity provider. scheme: bearer type: http ````