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

# Check Pix Keys Existence

> Use this endpoint to verify if the provided Pix keys exist in the DICT system.



## OpenAPI

````yaml /pt/openapi/v3-current/indirect-pix.yaml post /v1/dict/keys/check
openapi: 3.1.0
info:
  description: >-
    API for Pix Indirect via BTG. It covers DICT keys and claims; MED infraction
    reports, fraud markers, refund requests, and funds recoveries; DICT
    statistics and reconciliation; Pix transfers, refunds, and schedules; static
    QR codes and QR code decoding; immediate and due-date collections; Pix
    Automático for the payer; transaction reports and TemposTransacoes
    statistics; and inbound and outbound webhook records.
  title: Pix BTG API
  version: 1.12.0
servers:
  - url: https://api.example.com
    description: >-
      Replace the example host with the URL provided during environment
      onboarding.
security:
  - BearerAuth: []
paths:
  /v1/dict/keys/check:
    post:
      tags:
        - Keys
      summary: Check Pix Keys Existence
      description: >-
        Use this endpoint to verify if the provided Pix keys exist in the DICT
        system.
      operationId: dict-check-keys
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CheckKeysInput'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CheckKeysOutput'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LegacyErrorBody'
          description: Bad Request
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LegacyErrorBody'
          description: Internal Server Error
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LegacyErrorBody'
          description: Error
components:
  schemas:
    CheckKeysInput:
      additionalProperties: false
      properties:
        keys:
          description: List of PIX keys to verify existence
          items:
            $ref: '#/components/schemas/KeyCheckItem'
          maxItems: 200
          minItems: 1
          type: array
      required:
        - keys
      type: object
    CheckKeysOutput:
      additionalProperties: false
      properties:
        keys:
          description: Existence status for each verified key
          items:
            $ref: '#/components/schemas/KeyCheckResult'
          type: array
      required:
        - keys
      type: object
    LegacyErrorBody:
      additionalProperties: false
      properties:
        fields:
          additionalProperties:
            type: string
          type: object
        headers:
          additionalProperties:
            type: string
          type: object
        message:
          type: string
        paths:
          additionalProperties:
            type: string
          type: object
        queryParams:
          additionalProperties:
            type: string
          type: object
        raw:
          type: string
        code:
          type: string
        title:
          type: string
      required:
        - code
        - title
        - message
      type: object
    KeyCheckItem:
      additionalProperties: true
      properties:
        key:
          description: PIX key value to verify
          examples:
            - '+5561999999922'
          type: string
      type: object
    KeyCheckResult:
      additionalProperties: false
      properties:
        hasEntry:
          description: Indicates if the key exists in the DICT system
          examples:
            - true
          type: boolean
        key:
          description: PIX key that was verified
          examples:
            - '+5561999999922'
          type: string
      required:
        - key
        - hasEntry
      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.