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

# Estadísticas de claves PIX

> Devuelve los conteos de claves PIX agrupados por tipo de clave y estado.



## OpenAPI

````yaml es/openapi/v3-current/spi-dict.yaml get /api/v1/dict/keys/stats
openapi: 3.1.0
info:
  contact:
    email: contact@lerian.studio
    name: Lerian Studio
    url: https://lerian.studio
  description: >-
    Interfaz OpenAPI 3.1 de la capacidad DICT (Diretório de Identificadores de
    Contas Transacionais) de Lerian SPI, la integración directa entre la
    institución y el Sistema de Pagos Instantáneos Brasileño (SPI/Pix). Cubre el
    ciclo de vida de las claves PIX, los reclamos de portabilidad y titularidad,
    los reportes de infracción, las devoluciones, los marcadores de fraude, los
    reportes DICT síncronos y las operaciones internas de conciliación y
    aprovisionamiento que mantienen consistente el directorio de claves.
  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: >-
      Ciclo de vida de las claves PIX: registro, listado, búsqueda, consulta,
      eliminación y estadísticas.
    name: Keys
  - description: >-
      Reclamos de portabilidad y titularidad de claves PIX a lo largo de todo su
      ciclo de vida (iniciar, confirmar, rechazar, cancelar, reconocer,
      completar).
    name: Claims
  - description: 'Reportes de infracción DICT: crear, listar y recuperar.'
    name: Infractions
  - description: 'Solicitudes de devolución DICT: crear, listar y recuperar.'
    name: Refunds
  - description: 'Marcadores de fraude PIX: crear, listar y estadísticas.'
    name: Fraud Markers
  - description: >-
      Reportes síncronos sobre el propio registro DICT de Lerian SPI: resúmenes
      COUNT(*) de claves (por tipo/estado) y reclamos (por tipo/estado +
      vencidos sin resolver). Solo COUNT — DICT no retiene dinero.
    name: Reports
  - description: >-
      Operaciones internas de DICT: ejecuciones de conciliación,
      aprovisionamiento del ISPB del participante, procesamiento de plazos de
      reclamos y limpieza de claves huérfanas.
    name: Internal
paths:
  /api/v1/dict/keys/stats:
    get:
      tags:
        - Keys
      summary: Estadísticas de claves PIX
      description: Devuelve los conteos de claves PIX agrupados por tipo de clave y estado.
      operationId: keyStats
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KeyStatsResponse'
                description: PIX key counts grouped by key type and status
          description: OK
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
      security:
        - BearerAuth: []
components:
  schemas:
    KeyStatsResponse:
      additionalProperties: false
      properties:
        byStatus:
          additionalProperties:
            format: int64
            type: integer
          description: >-
            Key counts grouped by lifecycle status (ACTIVE, INACTIVE,
            PENDING_CLAIM, PENDING_BACEN_SYNC).
          type: object
        byType:
          additionalProperties:
            format: int64
            type: integer
          description: Key counts grouped by key type (CPF, CNPJ, EMAIL, PHONE, EVP).
          type: object
        generatedAt:
          description: Timestamp the statistics snapshot was generated, RFC 3339 (UTC).
          examples:
            - '2025-03-07T14:30:00Z'
          type: string
        total:
          description: Total number of PIX keys in scope.
          examples:
            - 10
          format: int64
          type: integer
      required:
        - total
        - byType
        - byStatus
        - generatedAt
      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
    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

````