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

# Get BACEN entry antifraud statistics

> Fetches BACEN's system-wide key-level antifraud statistics (owner + key blocks) by Pix key and projects them verbatim, with no local aggregation. A key BACEN DICT does not hold answers 404 with code SPI-1015; any other BACEN DICT refusal answers 422 with code SPI-1011.



## OpenAPI

````yaml /pt/openapi/v3-current/spi-dict.yaml get /api/v1/dict/entries/{key}/statistics
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/entries/{key}/statistics:
    get:
      tags:
        - Statistics
      summary: Get BACEN entry antifraud statistics
      description: >-
        Fetches BACEN's system-wide key-level antifraud statistics (owner + key
        blocks) by Pix key and projects them verbatim, with no local
        aggregation. A key BACEN DICT does not hold answers 404 with code
        SPI-1015; any other BACEN DICT refusal answers 422 with code SPI-1011.
      operationId: getEntryStatistics
      parameters:
        - description: Pix key value; statistics are fetched from BACEN by this key
          in: path
          name: key
          required: true
          schema:
            description: Pix key value; statistics are fetched from BACEN by this key
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntryStatisticsResponse'
                description: BACEN-served entry antifraud statistics, projected verbatim
          description: OK
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Forbidden
        '404':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Not Found
        '409':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Conflict
        '422':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Unprocessable Entity
        '429':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Too Many Requests
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Internal Server Error
        '503':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Service Unavailable
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
      security:
        - BearerAuth: []
components:
  schemas:
    EntryStatisticsResponse:
      additionalProperties: false
      properties:
        bacen:
          $ref: '#/components/schemas/BACENEnvelopeResponse'
          description: >-
            BACEN's own operational envelope for this call (this surface is a
            live pass-through with no local row; the envelope reflects THIS
            request, not a persisted last interaction).
        key:
          description: Pix key the statistics belong to
          examples:
            - '11122233300'
          type: string
        keyStatistics:
          $ref: '#/components/schemas/StatisticsBlocksResponse'
          description: Key-scoped statistics (verbatim)
        ownerStatistics:
          $ref: '#/components/schemas/StatisticsBlocksResponse'
          description: Owner-scoped statistics (verbatim)
      required:
        - key
        - ownerStatistics
        - keyStatistics
      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
    BACENEnvelopeResponse:
      additionalProperties: false
      properties:
        correlationId:
          description: >-
            BACEN's own correlation identifier for its most recent interaction
            on this record — the wire value, distinct from any request-scoped
            echo.
          examples:
            - a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4
          type: string
        lastModified:
          description: >-
            BACEN's own LastModified for this resource (RFC 3339, UTC) — the
            version this response reflects; present only on the MED resources
            (infraction, refund, fraud marker, funds recovery).
          examples:
            - '2026-06-14T12:00:00Z'
          type: string
        responseTime:
          description: >-
            Instant BACEN answered its most recent interaction on this record,
            RFC 3339 (UTC); omitted when BACEN's response carried no parseable
            instant.
          examples:
            - '2026-06-14T12:00:00Z'
          type: string
      required:
        - correlationId
      type: object
    StatisticsBlocksResponse:
      additionalProperties: false
      properties:
        entries:
          $ref: '#/components/schemas/StatisticsBlocksResponseEntriesStruct'
          description: Entry statistics
        fraudMarkers:
          $ref: '#/components/schemas/StatisticsBlocksResponseFraudMarkersStruct'
          description: Fraud-marker statistics
        infractionReports:
          $ref: '#/components/schemas/StatisticsBlocksResponseInfractionReportsStruct'
          description: Infraction-report statistics
        spi:
          $ref: '#/components/schemas/StatisticsBlocksResponseSpiStruct'
          description: SPI settlement statistics
      required:
        - spi
        - fraudMarkers
        - infractionReports
        - entries
      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
    StatisticsBlocksResponseEntriesStruct:
      additionalProperties: false
      properties:
        distinctAccounts:
          $ref: '#/components/schemas/StatWindowResponse'
          description: >-
            Key-scope: distinct accounts (windowed; omitted in owner block). A
            pointer so omitempty drops it for owner-scope (a plain struct would
            still serialize {})
        registeredAccounts:
          description: 'Owner-scope: registered accounts (scalar; omitted in key block)'
          examples:
            - '0'
          type: string
        watermark:
          description: Entries block watermark (RFC 3339)
          examples:
            - '2023-01-01T10:00:00.000Z'
          type: string
      required:
        - watermark
      type: object
    StatisticsBlocksResponseFraudMarkersStruct:
      additionalProperties: false
      properties:
        applicationFrauds:
          $ref: '#/components/schemas/StatWindowResponse'
        distinctFraudReporters:
          $ref: '#/components/schemas/StatWindowResponse'
        muleAccounts:
          $ref: '#/components/schemas/StatWindowResponse'
        otherFrauds:
          $ref: '#/components/schemas/StatWindowResponse'
        scammerAccounts:
          $ref: '#/components/schemas/StatWindowResponse'
        totalFraudTransactionAmount:
          $ref: '#/components/schemas/StatWindowResponse'
          description: Total fraud transaction amount (BACEN wire value, verbatim)
        unknownFrauds:
          $ref: '#/components/schemas/StatWindowResponse'
        watermark:
          description: FraudMarkers block watermark (RFC 3339)
          examples:
            - '2023-01-01T10:00:00.000Z'
          type: string
      required:
        - watermark
        - applicationFrauds
        - muleAccounts
        - scammerAccounts
        - otherFrauds
        - unknownFrauds
        - totalFraudTransactionAmount
        - distinctFraudReporters
      type: object
    StatisticsBlocksResponseInfractionReportsStruct:
      additionalProperties: false
      properties:
        openReports:
          description: Open infraction reports (scalar, not windowed)
          examples:
            - '0'
          type: string
        openReportsDistinctReporters:
          description: Distinct reporters of open reports (scalar, not windowed)
          examples:
            - '0'
          type: string
        rejectedReports:
          $ref: '#/components/schemas/StatWindowResponse'
        watermark:
          description: InfractionReports block watermark (RFC 3339)
          examples:
            - '2023-01-01T10:00:00.000Z'
          type: string
      required:
        - watermark
        - openReports
        - openReportsDistinctReporters
        - rejectedReports
      type: object
    StatisticsBlocksResponseSpiStruct:
      additionalProperties: false
      properties:
        settlements:
          $ref: '#/components/schemas/StatWindowResponse'
          description: SPI settlement counters
        watermark:
          description: SPI block watermark (RFC 3339)
          examples:
            - '2023-01-01T10:00:00.000Z'
          type: string
      required:
        - watermark
        - settlements
      type: object
    StatWindowResponse:
      additionalProperties: false
      properties:
        d90:
          description: Last 89 days including today (BACEN wire value, verbatim)
          examples:
            - '0'
          type: string
        m12:
          description: >-
            Last 12 calendar months excluding current month (BACEN wire value,
            verbatim)
          examples:
            - '0'
          type: string
        m60:
          description: >-
            Last 60 calendar months excluding current month (BACEN wire value,
            verbatim)
          examples:
            - '0'
          type: string
      required:
        - d90
        - m12
        - m60
      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.