> ## 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.

# List reconciliation cases

> Returns a page of reconciliation cases with operator-actionable filters. Cases are ordered by openedAt DESC. Cursor-based pagination — pass the nextCursor from a previous response to continue.



## OpenAPI

````yaml en/openapi/v3-current/spb.yaml get /v1/str/reconciliations
openapi: 3.1.0
info:
  contact:
    email: contact@lerian.studio
    name: Lerian Studio
    url: https://lerian.studio
  description: >-
    OpenAPI 3.1 surface for Lerian SPB, the direct integration between the
    institution and the Brazilian Payment System (SPB) over the National
    Financial System Network (RSFN). It covers the Reserve Transfer System
    (STR): message registry and capability catalog, operation lifecycle (bank
    transfers, IBS repasses, liquidity transfers, returns and cancellations),
    reserve-account and schedule queries, alçada governance, reconciliation, and
    event delivery.
  license:
    name: Lerian Studio General License
  title: Lerian SPB API
  version: 1.0.0
servers:
  - url: https://spb.sandbox.lerian.net
security: []
tags:
  - description: Immutable audit-record trails for STR operations and lifecycle events.
    name: Audit
  - description: >-
      STR capability catalog describing supported message types and their
      constraints.
    name: Capabilities
  - description: >-
      ICP-Brasil certificate inventory with hot-reloadable rotation and
      activation.
    name: Certificates
  - description: >-
      Maker-checker approval queue for emissions parked above their alçada band:
      list pending, sign (approve), and deny.
    name: EmissionApprovals
  - description: Webhook event-delivery records with retry control for failed dispatches.
    name: EventDeliveries
  - description: Operation event catalog enumerating the emitted domain event types.
    name: Events
  - description: >-
      Inbound GEN-family notice log (GEN0001 connectivity echo, GEN0004
      transmission error, GEN0005 administrative notice).
    name: GenNotices
  - description: >-
      SPB alçada governance: the value-band table and per-message-type signature
      requirements, hot-reloaded at runtime.
    name: Governance
  - description: >-
      Read raw STR message status: list messages and read a single message by
      NUOp.
    name: Messages
  - description: Aggregated operational summaries and metrics across STR operations.
    name: OperationalIntelligence
  - description: >-
      STR operation lifecycle for bank transfers and IBS repasses, including
      returns and cancellations.
    name: Operations
  - description: >-
      Service readiness state covering startup self-probes and dependency
      health.
    name: Readiness
  - description: Reconciliation cases and the actions that resolve operation discrepancies.
    name: Reconciliation
  - description: >-
      STR reports suite: synchronous, date-ranged aggregate reports (financial
      movement, rejected transactions, volumetria) over Lerian SPB's own
      transmission record.
    name: Reports
  - description: >-
      STR0013 reserve-account balance and STR0014 statement (extrato,
      message-mode) queries and their async results.
    name: ReserveQueries
  - description: >-
      GEN0019 participant responsável roster: full-replacement updates announced
      to BACEN.
    name: Responsibles
  - description: STR operating-window schedule governing when operations may be sent.
    name: Schedule
  - description: >-
      STR0001 single-party schedule queries (consulta de horários do STR) and
      their async STR0001R1 grid results.
    name: ScheduleQueries
  - description: Runtime SPB configuration settings for the STR integration.
    name: Settings
  - description: Webhook endpoint registration and management for event delivery.
    name: Webhooks
  - description: >-
      Flow (mandatory order): certificate → readiness → connectivity-test →
      submit. Activate a certificate, confirm the rail reports ready, pass a
      connectivity test, then submit an operation. Each step is its own
      resource; a submit must not be attempted before readiness passes.
    name: onboarding
  - description: >-
      Flow (mandatory order): parent operation SETTLED → return/cancel. A return
      or cancellation is a sub-resource of a settled parent operation; the
      {operationId}/{endToEndID} path segment enforces the parent structurally.
    name: lifecycle
paths:
  /v1/str/reconciliations:
    get:
      tags:
        - Reconciliation
      summary: List reconciliation cases
      description: >-
        Returns a page of reconciliation cases with operator-actionable filters.
        Cases are ordered by openedAt DESC. Cursor-based pagination — pass the
        nextCursor from a previous response to continue.
      operationId: listReconciliationCases
      parameters:
        - description: Case status filter (OPEN, IN_PROGRESS, RESOLVED, DISMISSED).
          explode: false
          in: query
          name: status
          schema:
            description: Case status filter (OPEN, IN_PROGRESS, RESOLVED, DISMISSED).
            type: string
        - description: Operation family filter.
          explode: false
          in: query
          name: operationFamily
          schema:
            description: Operation family filter.
            type: string
        - description: Operation aggregate UUID filter.
          explode: false
          in: query
          name: operationId
          schema:
            description: Operation aggregate UUID filter.
            type: string
        - description: Candidate reason code filter.
          explode: false
          in: query
          name: reasonCode
          schema:
            description: Candidate reason code filter.
            type: string
        - description: Inclusive start date (RFC3339 timestamp or YYYY-MM-DD).
          explode: false
          in: query
          name: startDate
          schema:
            description: Inclusive start date (RFC3339 timestamp or YYYY-MM-DD).
            type: string
        - description: Inclusive end date (RFC3339 timestamp or YYYY-MM-DD).
          explode: false
          in: query
          name: endDate
          schema:
            description: Inclusive end date (RFC3339 timestamp or YYYY-MM-DD).
            type: string
        - description: Opaque pagination cursor from a previous response.
          explode: false
          in: query
          name: cursor
          schema:
            description: Opaque pagination cursor from a previous response.
            type: string
        - description: Page size (1-100, default 50).
          explode: false
          in: query
          name: limit
          schema:
            default: 50
            description: Page size (1-100, default 50).
            format: int64
            maximum: 100
            minimum: 1
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReconciliationListResponse'
          description: OK
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
      security:
        - BearerAuth: []
components:
  schemas:
    ReconciliationListResponse:
      additionalProperties: false
      properties:
        correlationId:
          description: >-
            Request-scoped correlation identifier echoing X-Request-ID, for
            pivoting from response to trace.
          type: string
        items:
          description: Reconciliation cases on this page, ordered by openedAt DESC.
          items:
            $ref: '#/components/schemas/ReconciliationCaseResponse'
          type:
            - array
            - 'null'
        limit:
          description: Page size applied to this response (max items returned).
          format: int64
          type: integer
        nextCursor:
          description: >-
            Opaque cursor for the next page; absent when there are no further
            pages.
          type: string
        prevCursor:
          description: >-
            Opaque cursor for the previous page; reserved for future
            bidirectional cursoring, absent today.
          type: string
      required:
        - items
        - limit
        - correlationId
      type: object
    Detail:
      additionalProperties: false
      properties:
        code:
          description: >-
            Stable, machine-readable domain error code scoped to the emitting
            service (format: <SERVICE>-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
    ReconciliationCaseResponse:
      additionalProperties: false
      properties:
        createdAt:
          description: RFC3339 UTC row insertion timestamp.
          examples:
            - '2026-06-14T12:00:00Z'
          type: string
        nuOp:
          description: >-
            BACEN protocol identifier (NUOp) when no operation aggregate is
            known; null otherwise.
          examples:
            - NUOP1234567890
          type: string
        openedAt:
          description: RFC3339 UTC timestamp when the case was first detected.
          examples:
            - '2026-06-14T12:00:00Z'
          type: string
        operationFamily:
          description: >-
            Operation family the case belongs to (denormalized from
            str_operation for filter reads).
          examples:
            - bankTransfer
          type: string
        operationId:
          description: >-
            UUID of the str_operation this case is bound to; omitted for
            protocol-only anomalies discovered before an operation bridge
            exists.
          examples:
            - 7c8b3a2e-9f1d-4a55-9b8e-1e1234567890
          type: string
        protocolControlNumber:
          description: IF control number involved in the anomaly; null when not applicable.
          examples:
            - CTRL00012345
          type: string
        protocolMessageType:
          description: STR message code involved in the anomaly; null when not applicable.
          examples:
            - STR0004
          type: string
        reasonCode:
          description: >-
            Candidate reason the case was opened (operator-facing string, not a
            fixed enum).
          type: string
        recommendedAction:
          description: >-
            Optional suggested next step (e.g. INVESTIGATE, DISMISS, RESUBMIT);
            a hint, not a contract; null when absent.
          examples:
            - INVESTIGATE
          type: string
        reconciliationId:
          description: Reconciliation case row UUID.
          examples:
            - 9a2b7c1d-3e4f-4a90-8b21-1e1234567892
          type: string
        resolvedAt:
          description: >-
            RFC3339 UTC timestamp when the case transitioned to RESOLVED or
            DISMISSED; null while still open/in-progress.
          examples:
            - '2026-06-14T12:30:00Z'
          type: string
        status:
          description: 'Case lifecycle state: OPEN, IN_PROGRESS, RESOLVED, or DISMISSED.'
          examples:
            - OPEN
          type: string
        summary:
          description: >-
            Short safe operator-facing description of the case (no raw protocol
            payloads or PII).
          type: string
        updatedAt:
          description: >-
            RFC3339 UTC timestamp of the last mutation; updated on every state
            transition.
          examples:
            - '2026-06-14T12:30:00Z'
          type: string
      required:
        - reconciliationId
        - operationFamily
        - status
        - reasonCode
        - summary
        - openedAt
        - createdAt
        - 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

````