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

# Recuperar estatísticas de uma chave

> Use este endpoint para obter estatísticas de uso e de risco de uma chave
Pix específica.


**Notas:**

- Retorna tanto as estatísticas no nível da chave quanto as estatísticas
no nível do proprietário em uma única resposta.

- As estatísticas da chave rastreiam dados específicos da chave Pix como
uma entidade independente do seu proprietário atual.

- As estatísticas do proprietário fornecem os mesmos dados que o
endpoint de estatísticas da pessoa para o proprietário atual da chave.

- Este endpoint consulta o provedor diretamente e não armazena dados
localmente.

- Use essas informações para uma avaliação de risco abrangente ao
processar pagamentos para uma chave Pix.



## OpenAPI

````yaml pt/openapi/v3-current/indirect-pix.yaml GET /v1/dict/statistics/keys/{key}
openapi: 3.0.3
info:
  title: Plugin BR Pix Indireto - API Completa
  description: |
    API completa para o sistema brasileiro de pagamentos instantâneos Pix,
    incluindo operações de dicionário de chaves Pix, geração/decodificação de
    QR Code, transações e limites de transações.
  version: 1.0.0
servers:
  - url: https://plugin-pix-indirect.api.lerian.net
security:
  - bearerAuth: []
paths:
  /v1/dict/statistics/keys/{key}:
    get:
      tags:
        - MED API
      summary: Recuperar estatísticas de uma chave
      description: |-
        Use este endpoint para obter estatísticas de uso e de risco de uma chave
        Pix específica.


        **Notas:**

        - Retorna tanto as estatísticas no nível da chave quanto as estatísticas
        no nível do proprietário em uma única resposta.

        - As estatísticas da chave rastreiam dados específicos da chave Pix como
        uma entidade independente do seu proprietário atual.

        - As estatísticas do proprietário fornecem os mesmos dados que o
        endpoint de estatísticas da pessoa para o proprietário atual da chave.

        - Este endpoint consulta o provedor diretamente e não armazena dados
        localmente.

        - Use essas informações para uma avaliação de risco abrangente ao
        processar pagamentos para uma chave Pix.
      parameters:
        - $ref: '#/components/parameters/KeyPath'
      responses:
        '200':
          description: Estatísticas da chave recuperadas com sucesso.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KeyStatisticsOutput'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorFormat'
              examples:
                ErrorPIX0001:
                  $ref: '#/components/examples/ErrorPIX0001'
                ErrorPIX0008:
                  $ref: '#/components/examples/ErrorPIX0008'
                ErrorPIX0280:
                  $ref: '#/components/examples/ErrorPIX0280'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorFormat'
              examples:
                ErrorPIX1091:
                  $ref: '#/components/examples/ErrorPIX1091'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorFormat'
              examples:
                ErrorPIX0000:
                  $ref: '#/components/examples/ErrorPIX0000'
        '502':
          description: Bad Gateway
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorFormat'
              examples:
                ErrorPIX1000:
                  $ref: '#/components/examples/ErrorPIX1000'
                ErrorPIX1007:
                  $ref: '#/components/examples/ErrorPIX1007'
                ErrorPIX1099:
                  $ref: '#/components/examples/ErrorPIX1099'
      deprecated: false
      security:
        - bearerAuth: []
components:
  parameters:
    KeyPath:
      name: key
      in: path
      description: Valor da chave Pix (CPF, CNPJ, E-mail, Telefone ou EVP).
      required: true
      example: john.doe@example.com
      schema:
        type: string
  schemas:
    KeyStatisticsOutput:
      type: object
      properties:
        keyStatistics:
          type: object
          description: Estatísticas específicas da chave Pix.
        ownerStatistics:
          type: object
          description: Estatísticas do proprietário da chave.
    ErrorFormat:
      type: object
      description: A mensagem de erro da resposta.
      required:
        - code
        - title
        - message
      properties:
        code:
          type: string
          description: Um identificador único e estável para o erro.
        title:
          type: string
          description: Um breve resumo do problema.
        message:
          type: string
          description: Orientação detalhada para resolver o erro.
  examples:
    ErrorPIX0001:
      summary: Missing Headers in Request
      value:
        code: PIX-0001
        title: Missing Headers in Request
        message: >-
          Your request is missing one or more required header params. Please
          refer to the documentation to ensure all necessary header params are
          included in your request.
    ErrorPIX0008:
      summary: Invalid Path Parameter in Request
      value:
        code: PIX-0008
        title: Invalid Path Parameter in Request
        message: >-
          One or more path parameters are invalid. Please refer to the
          documentation to verify the expected format and allowed values for
          each path parameter.
    ErrorPIX0280:
      summary: Invalid Key Value
      value:
        code: PIX-0280
        title: Invalid Key Value
        message: >-
          The key value is invalid or exceeds the maximum length of 77
          characters.
    ErrorPIX1091:
      summary: Key Statistics Not Found
      value:
        code: PIX-1091
        title: Key Statistics Not Found
        message: >-
          The provider reports that no statistics were found for the specified
          Pix key.
    ErrorPIX0000:
      summary: Internal Server Error
      value:
        code: PIX-0000
        title: Internal Server Error
        message: The server encountered an unexpected error. Please try again later.
    ErrorPIX1000:
      summary: Provider Connection Error
      value:
        code: PIX-1000
        title: Provider Connection Error
        message: Failed to connect to provider.
    ErrorPIX1007:
      summary: Provider Internal Error
      value:
        code: PIX-1007
        title: Provider Internal Error
        message: Provider returned an internal error.
    ErrorPIX1099:
      summary: Provider Unmapped Error
      value:
        code: PIX-1099
        title: Provider Unmapped Error
        message: Provider returned an unmapped error.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````