> ## 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. # Obter prontidão do serviço > Pré-requisito: um certificado ativo (ver rotateCertificate, activateCertificate) antes de a prontidão reportar READY; um relatório de prontidão READY é, por sua vez, o pré-requisito de um teste de conectividade (ver createConnectivityTest) e de qualquer operação de envio (ver createBankTransferOperation). Retorna o resumo de prontidão operacional do serviço, incluindo a conectividade de banco de dados, a janela de validade do certificado, o binding de configurações de canal e quaisquer subsistemas degradados. É usado pelos dashboards de operações e pelas comportas prévias antes do envio ao STR. Independente da verificação global /readyz do Kubernetes: este endpoint reporta o estado de prontidão operacional do participante, enquanto /readyz reporta a saúde de dependências em nível de processo. ## OpenAPI ````yaml pt/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: >- Interface OpenAPI 3.1 do Lerian SPB, a integração direta entre a instituição e o Sistema de Pagamentos Brasileiro (SPB) sobre a Rede do Sistema Financeiro Nacional (RSFN). Abrange o Sistema de Transferência de Reservas (STR): registro de mensagens e catálogo de capacidades, ciclo de vida das operações (transferências bancárias, repasses IBS, transferências de liquidez, devoluções e cancelamentos), consultas de conta de reservas e de horários, governança de alçada, conciliação e 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: >- Trilhas imutáveis de registros de auditoria para operações STR e eventos de ciclo de vida. name: Audit - description: >- Catálogo de capacidades STR que descreve os tipos de mensagem suportados e suas restrições. name: Capabilities - description: >- Inventário de certificados ICP-Brasil com rotação e ativação recarregáveis a quente. name: Certificates - description: >- Fila de aprovação maker-checker para emissões retidas acima de sua banda de alçada: listar pendentes, assinar (aprovar) e negar. name: EmissionApprovals - description: >- Registros de entrega de eventos por webhook com controle de retentativas para despachos falhos. name: EventDeliveries - description: >- Catálogo de eventos de operação que enumera os tipos de evento de domínio emitidos. name: Events - description: >- Registro de avisos recebidos da família GEN (GEN0001 eco de conectividade, GEN0004 erro de transmissão, GEN0005 aviso administrativo). name: GenNotices - description: >- Governança de alçada do SPB: a tabela de bandas de valor e os requisitos de assinatura por tipo de mensagem, recarregados a quente em tempo de execução. name: Governance - description: >- Estado bruto das mensagens STR: listar as mensagens e ler uma mensagem individual por NUOp. name: Messages - description: Resumos e métricas operacionais agregados das operações STR. name: OperationalIntelligence - description: >- Ciclo de vida das operações STR para transferências bancárias e repasses IBS, incluindo devoluções e cancelamentos. name: Operations - description: >- Estado de prontidão do serviço que abrange as autoverificações de inicialização e a saúde das dependências. name: Readiness - description: Casos de conciliação e as ações que resolvem as divergências de operação. name: Reconciliation - description: >- Suíte de relatórios STR: relatórios agregados síncronos por intervalo de datas (movimento financeiro, transações rejeitadas, volumetria) sobre o próprio registro de transmissão do Lerian SPB. name: Reports - description: >- Consultas de saldo de conta de reservas STR0013 e de extrato STR0014 (modo mensagem) e seus resultados assíncronos. name: ReserveQueries - description: >- Lista de responsáveis do participante GEN0019: atualizações de substituição total anunciadas ao BACEN. name: Responsibles - description: >- Programação de janelas de operação do STR que rege quando as operações podem ser enviadas. name: Schedule - description: >- Consultas de horários STR0001 de parte única (consulta de horários do STR) e seus resultados de grade STR0001R1 assíncronos. name: ScheduleQueries - description: Configurações de tempo de execução do SPB para a integração STR. name: Settings - description: >- Registro e gerenciamento de endpoints de webhook para a entrega de eventos. name: Webhooks - description: >- Fluxo (ordem obrigatória): certificado → prontidão → teste-de-conectividade → envio. Ative um certificado, confirme que o rail reporta prontidão, passe em um teste de conectividade e então envie uma operação. Cada etapa é seu próprio recurso; um envio não deve ser tentado antes de a prontidão passar. name: onboarding - description: >- Fluxo (ordem obrigatória): operação pai SETTLED → devolução/cancelamento. Uma devolução ou cancelamento é um sub-recurso de uma operação pai liquidada; o segmento de rota {operationId}/{endToEndID} impõe o pai estruturalmente. name: lifecycle paths: /v1/str/readiness: get: tags: - Readiness - onboarding summary: Obter prontidão do serviço description: >- Pré-requisito: um certificado ativo (ver rotateCertificate, activateCertificate) antes de a prontidão reportar READY; um relatório de prontidão READY é, por sua vez, o pré-requisito de um teste de conectividade (ver createConnectivityTest) e de qualquer operação de envio (ver createBankTransferOperation). Retorna o resumo de prontidão operacional do serviço, incluindo a conectividade de banco de dados, a janela de validade do certificado, o binding de configurações de canal e quaisquer subsistemas degradados. É usado pelos dashboards de operações e pelas comportas prévias antes do envio ao STR. Independente da verificação global /readyz do Kubernetes: este endpoint reporta o estado de prontidão operacional do participante, enquanto /readyz reporta a saúde de dependências em nível de processo. 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 ````