> ## 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 Keys Existence

> Use this endpoint to verify if the provided Pix keys exist in the DICT
system. This operation allows batch verification of multiple keys in a
single request.



## OpenAPI

````yaml /en/openapi/v3-current/indirect-pix.yaml post /v1/dict/keys/check
openapi: 3.0.3
info:
  title: Plugin BR Pix Indirect - Complete API
  description: |
    Complete API for Brazilian Pix instant payment system including
    Pix key dictionary operations, QR code generation/decoding, transactions and
    transaction limits.
  version: 1.0.0
servers:
  - url: https://plugin-pix-indirect.api.lerian.net
security:
  - bearerAuth: []
paths:
  /v1/dict/keys/check:
    post:
      tags:
        - DICT API
      summary: Check Keys Existence
      description: |-
        Use this endpoint to verify if the provided Pix keys exist in the DICT
        system. This operation allows batch verification of multiple keys in a
        single request.
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CheckKeysInput'
            example:
              keys:
                - key: '+5561999999922'
                - key: john.doe@example.com
      responses:
        '200':
          description: Keys check completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CheckKeysOutput'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorFormat'
              examples:
                ErrorPIX0001:
                  $ref: '#/components/examples/ErrorPIX0001'
                ErrorPIX0003:
                  $ref: '#/components/examples/ErrorPIX0003'
                ErrorPIX0004:
                  $ref: '#/components/examples/ErrorPIX0004'
                ErrorPIX0005:
                  $ref: '#/components/examples/ErrorPIX0005'
                ErrorPIX0116:
                  $ref: '#/components/examples/ErrorPIX0116'
                ErrorPIX0117:
                  $ref: '#/components/examples/ErrorPIX0117'
        '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:
  schemas:
    CheckKeysInput:
      type: object
      required:
        - keys
      properties:
        keys:
          type: array
          description: List of Pix keys to verify existence.
          maxItems: 200
          minItems: 1
          items:
            type: object
            required:
              - key
            properties:
              key:
                type: string
                description: Pix key value to verify.
                example: '+5561999999922'
    CheckKeysOutput:
      type: object
      properties:
        keys:
          type: array
          items:
            type: object
            properties:
              key:
                type: string
                description: Pix key value that was verified.
                example: '+5561999999922'
              hasEntry:
                type: boolean
                description: Indicates if the key exists in the DICT system.
                example: true
    ErrorFormat:
      type: object
      description: The response message error.
      required:
        - code
        - title
        - message
      properties:
        code:
          type: string
          description: A unique, stable identifier for the error.
        title:
          type: string
          description: A brief summary of the issue.
        message:
          type: string
          description: Detailed guidance for resolving the error.
  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.
    ErrorPIX0003:
      summary: Missing Fields in Request
      value:
        code: PIX-0003
        title: Missing Fields in Request
        message: >-
          Your request is missing one or more required fields. Please refer to
          the documentation to ensure all necessary fields are included in your
          request.
    ErrorPIX0004:
      summary: Invalid Field Values in Request
      value:
        code: PIX-0004
        title: Invalid Field Values in Request
        message: >-
          Your request contains one or more fields with invalid values. Please
          refer to the documentation to verify that all fields have the correct
          values.
    ErrorPIX0005:
      summary: Invalid Field Type in Request
      value:
        code: PIX-0005
        title: Invalid Field Type in Request
        message: >-
          Your request contains one or more fields with an invalid data type.
          Please refer to the documentation to verify that all fields have the
          correct type.
    ErrorPIX0116:
      summary: Empty Keys Array
      value:
        code: PIX-0116
        title: Empty Keys Array
        message: The keys array must not be empty.
    ErrorPIX0117:
      summary: Keys Array Exceeded Limit
      value:
        code: PIX-0117
        title: Keys Array Exceeded Limit
        message: The keys array must not exceed 200 items.
    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

````