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

# DICT claims-summary report (COUNT-only)

> Returns COUNT(*) buckets grouped by (claimType, status) over claims requested in a mandatory date window (max 92 days), plus the COUNT of currently-open claims past their 7-day deadline. COUNT-only. Infraction summaries are out of scope.



## OpenAPI

````yaml /pt/openapi/v3-current/spi-dict.yaml get /api/v1/dict/reports/claims-summary
openapi: 3.1.0
info:
  contact:
    email: contact@lerian.studio
    name: Lerian Studio
    url: https://lerian.studio
  description: >-
    OpenAPI 3.1 surface for the DICT (Diretório de Identificadores de Contas
    Transacionais) capability of Lerian SPI, the direct integration between the
    institution and the Brazilian Instant Payment System (SPI/Pix). It covers
    the PIX key lifecycle, portability and ownership claims, the MED 2.0 dispute
    surface (infraction reports, refunds, fraud markers, and funds recoveries),
    antifraud statistics, synchronous DICT reports, and the internal operations
    that keep the key directory consistent.
  license:
    name: Lerian Studio General License
  title: Lerian SPI — DICT API
  version: 1.0.0
servers:
  - url: https://api.example.com
    description: >-
      Replace the example host with the URL provided during environment
      onboarding.
security: []
tags:
  - description: 'PIX key lifecycle: register, list, search, lookup, delete, and statistics.'
    name: Keys
  - description: >-
      PIX key portability and ownership claims through their full lifecycle
      (initiate, confirm, reject, cancel, acknowledge, complete).
    name: Claims
  - description: 'DICT infraction reports: list and retrieve.'
    name: Infractions
  - description: 'DICT refund requests: create, list, and retrieve.'
    name: Refunds
  - description: 'PIX fraud markers: create, list, and statistics.'
    name: Fraud Markers
  - description: >-
      Durable MED operation-intent status: the operationId every
      create/lifecycle-transition backlog route returns or references on every
      outcome, queryable independently of the business resource.
    name: Operations
  - description: >-
      Synchronous reports over Lerian SPI's own DICT record: COUNT(*) summaries
      of keys (by type/status) and claims (by type/status + open-past-deadline).
      COUNT-only — DICT holds no money.
    name: Reports
  - description: >-
      DICT 8.4 section 13.2.3 query monitoring: read the query indicators, block
      or release an end user after a founded suspicion, and read the DICT
      request-limiting token buckets.
    name: Query Monitoring
  - description: >-
      DICT synchronism checks transported to BACEN for the participant named in
      X-ISPB: sync verification, CID resolution and CID set events, projected
      verbatim.
    name: VSync
paths:
  /api/v1/dict/reports/claims-summary:
    get:
      tags:
        - Reports
      summary: DICT claims-summary report (COUNT-only)
      description: >-
        Returns COUNT(*) buckets grouped by (claimType, status) over claims
        requested in a mandatory date window (max 92 days), plus the COUNT of
        currently-open claims past their 7-day deadline. COUNT-only. Infraction
        summaries are out of scope.
      operationId: getDICTReportClaimsSummary
      parameters:
        - description: Inclusive start of the report window (YYYY-MM-DD UTC). Required.
          explode: false
          in: query
          name: fromDate
          required: true
          schema:
            description: Inclusive start of the report window (YYYY-MM-DD UTC). Required.
            examples:
              - '2026-06-01'
            type: string
        - description: >-
            Inclusive end of the report window (YYYY-MM-DD UTC). Required. The
            window may not exceed 92 days.
          explode: false
          in: query
          name: toDate
          required: true
          schema:
            description: >-
              Inclusive end of the report window (YYYY-MM-DD UTC). Required. The
              window may not exceed 92 days.
            examples:
              - '2026-06-30'
            type: string
        - description: >-
            Optional: when true, adds the per-indirect-participant dimension to
            the COUNT(*) GROUP BY. COUNT-only either way.
          explode: false
          in: query
          name: groupByParticipant
          schema:
            description: >-
              Optional: when true, adds the per-indirect-participant dimension
              to the COUNT(*) GROUP BY. COUNT-only either way.
            examples:
              - false
            type: boolean
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DICTClaimsSummaryResponse'
          description: OK
        '422':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Unprocessable Entity
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Internal Server Error
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
      security:
        - BearerAuth: []
components:
  schemas:
    DICTClaimsSummaryResponse:
      additionalProperties: false
      properties:
        asOf:
          description: >-
            The instant the open-claims-past-deadline COUNT was evaluated (RFC
            3339 UTC).
          examples:
            - '2026-06-21T12:00:00Z'
          type: string
        buckets:
          description: >-
            COUNT(*) buckets grouped by (claimType, status) over claims
            requested in the window.
          items:
            $ref: '#/components/schemas/DICTClaimSummaryBucket'
          type: array
        countOnly:
          description: Always true — DICT summaries are COUNT-only (no monetary field).
          examples:
            - true
          type: boolean
        openClaimsPastDeadline:
          description: >-
            COUNT of currently-open claims whose 7-day deadline has passed (a
            count, never a position). Current-state, not window-filtered.
          examples:
            - 3
          format: int64
          type: integer
        window:
          $ref: '#/components/schemas/DICTReportWindowResponse'
          description: Echo of the resolved report window.
      required:
        - countOnly
        - buckets
        - openClaimsPastDeadline
        - asOf
        - window
      type: object
    Detail:
      additionalProperties: false
      properties:
        code:
          description: >-
            Stable, machine-readable domain error code scoped to the emitting
            service (format: <SERVICE>-NNNN).
          type: string
        correlationId:
          description: Request-scoped correlation identifier echoing X-Request-ID.
          examples:
            - req-7a3f9c2e
          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
        upstream:
          $ref: '#/components/schemas/Upstream'
          description: >-
            RFC 9457 extension member: the error a proxied third-party provider
            reported. Absent unless the emitting service explicitly surfaced
            one.
      required:
        - correlationId
      type: object
    DICTClaimSummaryBucket:
      additionalProperties: false
      properties:
        claimType:
          description: Claim type (OWNERSHIP/PORTABILITY).
          examples:
            - OWNERSHIP
          type: string
        claimerISPB:
          description: >-
            Claiming participant ISPB for this bucket; present only when
            groupByParticipant=true.
          examples:
            - '12345678'
          type: string
        count:
          description: Record COUNT for this bucket.
          examples:
            - 5
          format: int64
          type: integer
        status:
          description: >-
            Claim status
            (OPEN/WAITING_RESOLUTION/CONFIRMED/CANCELLED/COMPLETED).
          examples:
            - OPEN
          type: string
      required:
        - claimType
        - status
        - count
      type: object
    DICTReportWindowResponse:
      additionalProperties: false
      properties:
        fromDate:
          description: Inclusive window start (UTC).
          examples:
            - '2026-06-01'
          type: string
        toDate:
          description: Inclusive window end (UTC).
          examples:
            - '2026-06-30'
          type: string
      required:
        - fromDate
        - toDate
      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
    Upstream:
      additionalProperties: false
      properties:
        code:
          description: The upstream provider's own error code, verbatim.
          examples:
            - E4001
          type: string
        message:
          description: >-
            The upstream provider's own error message, verbatim (bounded, never
            its raw response body).
          examples:
            - account not found at provider
          type: string
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: JWT bearer token issued by the identity provider.
      scheme: bearer
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.