> ## 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. # PIX key statistics > Returns PIX key counts grouped by key type and status. ## OpenAPI ````yaml /pt/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: >- 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: 'Internal DICT operations: claim deadline processing.' name: Internal - 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/keys/stats: get: tags: - Keys summary: PIX key statistics description: Returns PIX key counts grouped by key type and status. operationId: keyStats responses: '200': content: application/json: schema: $ref: '#/components/schemas/KeyStatsResponse' description: PIX key counts grouped by key type and status description: OK '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: KeyStatsResponse: additionalProperties: false properties: byStatus: additionalProperties: format: int64 type: integer description: Key counts grouped by lifecycle status (ACTIVE, PENDING_CLAIM). 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: -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 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.