> ## 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 keys-summary report (COUNT-only)

> Returns COUNT(*) buckets grouped by (keyType, status) over PIX keys registered in a mandatory date window (max 92 days). COUNT-only — DICT holds no money. Raw key values are never returned.



## OpenAPI

````yaml en/openapi/v3-current/spi-dict.yaml get /api/v1/dict/reports/keys-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, infraction reports,
    refunds, fraud markers, synchronous DICT reports, and the internal
    reconciliation and provisioning 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://spi.sandbox.lerian.net
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: create, 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: >-
      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: >-
      Internal DICT operations: reconciliation runs, participant ISPB
      provisioning, claim deadline processing, and orphaned-key cleanup.
    name: Internal
paths:
  /api/v1/dict/reports/keys-summary:
    get:
      tags:
        - Reports
      summary: DICT keys-summary report (COUNT-only)
      description: >-
        Returns COUNT(*) buckets grouped by (keyType, status) over PIX keys
        registered in a mandatory date window (max 92 days). COUNT-only — DICT
        holds no money. Raw key values are never returned.
      operationId: getDICTReportKeysSummary
      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/DICTKeysSummaryResponse'
          description: OK
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
      security:
        - BearerAuth: []
components:
  schemas:
    DICTKeysSummaryResponse:
      additionalProperties: false
      properties:
        buckets:
          description: >-
            COUNT(*) buckets grouped by (keyType, status) over keys registered
            in the window.
          items:
            $ref: '#/components/schemas/DICTKeySummaryBucket'
          type:
            - array
            - 'null'
        countOnly:
          description: Always true — DICT summaries are COUNT-only (no monetary field).
          examples:
            - true
          type: boolean
        window:
          $ref: '#/components/schemas/DICTReportWindowResponse'
          description: Echo of the resolved report window.
      required:
        - countOnly
        - buckets
        - window
      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
    DICTKeySummaryBucket:
      additionalProperties: false
      properties:
        count:
          description: Record COUNT for this bucket.
          examples:
            - 128
          format: int64
          type: integer
        keyType:
          description: PIX key type (CPF/CNPJ/EMAIL/PHONE/EVP).
          examples:
            - CPF
          type: string
        participantISPB:
          description: >-
            Indirect participant ISPB for this bucket; present only when
            groupByParticipant=true.
          examples:
            - '12345678'
          type: string
        status:
          description: Key status (ACTIVE/INACTIVE/PENDING_CLAIM/PENDING_BACEN_SYNC).
          examples:
            - ACTIVE
          type: string
      required:
        - keyType
        - 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
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: JWT bearer token issued by the identity provider.
      scheme: bearer
      type: http

````