> ## 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 generated reports

> Lists the request tenant's generated/available SLC (Serviço de Liquidação Centralizada) reports (reports table), newest first. This is a read-only facade — the rows are written by the ASLC9xx (família de mensagens de intake de relatório) intake pipeline. Filter: limit (default page size when omitted). RBAC: reports:read; tenant is always derived from the validated request identity, never a query or path param.



## OpenAPI

````yaml en/openapi/v3-current/slc.yaml get /v1/reports
openapi: 3.1.0
info:
  description: >-
    API for Lerian SLC — the participant-side rail that connects the institution
    to Núclea's SLC deferred-net card settlement. It covers settlement-operation
    intake and lifecycle, clearing positions, the participant and arrangement
    registry, generated reports, embedded XSD schema introspection, transmission
    recovery and connectivity to Núclea, BYOK Model-A signing-key import, and
    tenant-scoped webhooks.
  title: Lerian SLC API
  version: 1.0.0
servers:
  - url: https://slc.sandbox.lerian.net
security:
  - BearerAuth: []
tags:
  - description: >-
      Settlement operation lifecycle — create, list, query, and control the
      NUliquid-tracked card operations (NUliquid = the 21-position id Núclea
      assigns each accepted operation) through the state machine.
    name: Operations
  - description: >-
      Participant catalog — the acquirers, sub-acquirers, IF Domicílio (bank
      where the merchant receives its sales), and settlement FIs (financial
      institutions) that take part in card settlement.
    name: Participants
  - description: >-
      Card arrangements (bandeira/scheme configurations, e.g. Visa/Master/Elo)
      attached to a participant.
    name: Arrangements
  - description: >-
      Regulated transport orchestration to Núclea/SILOC (the private card
      clearing house that operates the SILOC settlement system) — dispatch,
      recovery, retransmission, and connectivity testing over managed
      file-transfer, message-broker, and REST.
    name: Connectivity
  - description: >-
      Multilateral netting clearing positions — the net amount each participant
      settles per STR cycle (STR = Banco Central reserves-transfer system).
    name: Clearing
  - description: >-
      SaaS BYOK (Bring Your Own Key) signing-key provisioning — import
      parameters and register the client's ICP-Brasil A1 (Brazilian PKI server
      certificate, 1-year validity) certificate material used to sign ASLC
      files; the private key never leaves the client's HSM/KMS/Vault.
    name: SigningKey
  - description: >-
      ASLC file intake and status — passthrough submission and processing status
      of the official Núclea card-settlement XML files (ASLC = Arquivo do
      Sistema de Liquidação de Cartões).
    name: Files
  - description: >-
      Read-only introspection of the embedded Núclea ASLC/RSFN (National
      Financial System Network) XSD schemas used to validate outbound and
      inbound messages.
    name: XSD Schemas
  - description: Read-only regulatory, compliance, and operational settlement reports.
    name: Reports
  - description: >-
      Outbound business-event webhook subscriptions and delivery management for
      consumers (Midaz, client ledgers, Cabine — all optional).
    name: Webhooks
  - description: >-
      Administrative operations — hot-reloadable runtime configuration,
      dead-letter-queue inspection/replay, and outbox redispatch.
    name: Admin
paths:
  /v1/reports:
    get:
      tags:
        - Reports
      summary: List generated reports
      description: >-
        Lists the request tenant's generated/available SLC (Serviço de
        Liquidação Centralizada) reports (reports table), newest first. This is
        a read-only facade — the rows are written by the ASLC9xx (família de
        mensagens de intake de relatório) intake pipeline. Filter: limit
        (default page size when omitted). RBAC: reports:read; tenant is always
        derived from the validated request identity, never a query or path
        param.
      operationId: listReports
      parameters:
        - description: >-
            Page size (default 50). A negative/non-numeric value is rejected
            with 400; an omitted value applies the adapter default.
          explode: false
          in: query
          name: limit
          schema:
            description: >-
              Page size (default 50). A negative/non-numeric value is rejected
              with 400; an omitted value applies the adapter default.
            examples:
              - '50'
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListReportsResponse'
          description: OK
        '501':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: >-
            Not Implemented: this capability is not part of this deployment.
            Operations are registered unconditionally so the published contract
            is identical across deploy shapes; when the capability behind one
            did not compose here (authentication disabled, no database, no
            outbound transport, or the feature switched off) it answers this
            coded SLC-0012 problem. It is definitive for this deployment:
            retrying does not help, and the `detail` is deliberately scrubbed
            (any status >= 500 is).
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
components:
  schemas:
    ListReportsResponse:
      additionalProperties: false
      properties:
        items:
          description: >-
            Generated/available reports for the request tenant, newest first
            (empty array when none).
          items:
            $ref: '#/components/schemas/ReportResponse'
          type:
            - array
            - 'null'
      required:
        - items
      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
    ReportResponse:
      additionalProperties: false
      properties:
        ackControlNumber:
          description: Núclea acknowledgement control number, omitted when absent.
          examples:
            - '20260615000012345'
          type: string
        ackReceivedAt:
          description: >-
            Timestamp the Núclea acknowledgement was received, null when not yet
            acknowledged (RFC3339).
          examples:
            - '2026-06-15T07:50:00Z'
          format: date-time
          type:
            - string
            - 'null'
        availableAt:
          description: >-
            Timestamp the report became available for pickup, null when not yet
            available (RFC3339).
          examples:
            - '2026-06-15T08:00:00Z'
          format: date-time
          type:
            - string
            - 'null'
        category:
          description: Report category.
          examples:
            - SETTLEMENT
          type: string
        createdAt:
          description: Timestamp the report row was created (RFC3339).
          examples:
            - '2026-06-15T07:50:00Z'
          format: date-time
          type: string
        expiresAt:
          description: >-
            Timestamp the report is no longer available for pickup, null when
            open-ended (RFC3339).
          examples:
            - '2026-06-18T08:00:00Z'
          format: date-time
          type:
            - string
            - 'null'
        filePath:
          description: Storage path of the materialized report file, omitted when absent.
          examples:
            - reports/2026/06/15/settlement-summary.pdf
          type: string
        id:
          description: Report id (UUID).
          examples:
            - 018f8a3e-4b2c-7c1a-9e5d-2f6a1b3c4d5e
          type: string
        recordsCount:
          description: Number of records the report contains, null when unknown.
          examples:
            - 1200
          format: int64
          type:
            - integer
            - 'null'
        referenceDate:
          description: Settlement reference date the report covers (RFC3339).
          examples:
            - '2026-06-15T00:00:00Z'
          format: date-time
          type: string
        requestId:
          description: >-
            Originating request id (UUID) that produced this report, omitted
            when absent.
          examples:
            - 0190b5a0-0000-7000-8000-0000000000aa
          type: string
        source:
          description: >-
            Origin of the report (e.g. the ASLC9xx intake pipeline), omitted
            when absent.
          examples:
            - ASLC900
          type: string
        state:
          description: Report lifecycle state.
          examples:
            - READY
          type: string
        type:
          description: Report type name.
          examples:
            - SETTLEMENT_SUMMARY
          type: string
      required:
        - id
        - type
        - category
        - referenceDate
        - state
        - ackReceivedAt
        - recordsCount
        - availableAt
        - expiresAt
        - createdAt
      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

````