> ## 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 whether Pix keys exist

> Verifies whether the provided Pix keys exist in the DICT system. Supports batch verification of multiple keys in a single request.



## OpenAPI

````yaml en/openapi/v3-current/pix-lerian-dict.yaml POST /keys/check
openapi: 3.1.0
info:
  contact:
    name: Lerian Studio
    url: https://lerian.studio
  description: >-
    Public API for Pix keys, claims, fraud markers, infraction reports, and MED
    funds recovery.
  license:
    name: Elastic License 2.0
    url: https://www.elastic.co/licensing/elastic-license
  title: Pix Lerian — DICT
  version: release-candidate
servers:
  - url: https://api.example.com/dict-hub/v1
    description: >-
      Replace the example host with the URL provided during environment
      onboarding.
security:
  - BearerAuth: []
tags:
  - description: Register, retrieve, list, update, and remove Pix keys.
    name: Entries
  - description: Look up Pix keys and check whether keys exist in the DICT directory.
    name: Keys
  - description: Manage ownership and portability claims for Pix keys.
    name: Claims
  - description: Manage participant-scoped MED 2.0 funds recoveries.
    name: Funds Recoveries
  - description: Manage MED 2.0 infraction reports for the authenticated organization.
    name: Infraction Reports
  - description: Create, query, cancel, and settle MED 2.0 refunds.
    name: Refunds
  - description: Create, query, list, and cancel DICT fraud markers.
    name: Fraud Markers
paths:
  /keys/check:
    post:
      tags:
        - Keys
      summary: Check whether Pix keys exist
      description: >-
        Verifies whether the provided Pix keys exist in the DICT system.
        Supports batch verification of multiple keys in a single request.
      operationId: checkKeysExistence
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CheckKeysExistenceBody'
            examples:
              fictitiousExample:
                summary: Fictitious example
                value:
                  keys:
                    - key: '52998224725'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CheckKeysExistenceOutput'
              examples:
                fictitiousExample:
                  summary: Fictitious example
                  value:
                    keys:
                      - hasEntry: true
                        key: '52998224725'
          description: OK
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
      x-codeSamples:
        - lang: bash
          label: cURL with fictitious data
          source: |-
            curl --request POST \
              --url https://api.example.com/dict-hub/v1/keys/check \
              --header 'Authorization: Bearer demo-access-token' \
              --header 'Content-Type: application/json' \
              --data '{
              "keys": [
                {
                  "key": "52998224725"
                }
              ]
            }'
components:
  schemas:
    CheckKeysExistenceBody:
      additionalProperties: false
      properties:
        keys:
          items:
            $ref: '#/components/schemas/KeyCheckItemRequest'
          type:
            - array
            - 'null'
      required:
        - keys
      type: object
    CheckKeysExistenceOutput:
      additionalProperties: false
      properties:
        keys:
          items:
            $ref: '#/components/schemas/KeyCheckResultOutput'
          type:
            - array
            - 'null'
      required:
        - keys
      type: object
    Detail:
      additionalProperties: false
      properties:
        code:
          description: >-
            Stable, machine-readable domain error code scoped to the emitting
            service (format: <SERVICE>-NNNN).
          examples:
            - ERR-0001
          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.
      type: object
    KeyCheckItemRequest:
      additionalProperties: false
      properties:
        key:
          description: Pix key value
          examples:
            - '52998224725'
          type: string
      required:
        - key
      type: object
    KeyCheckResultOutput:
      additionalProperties: false
      properties:
        hasEntry:
          examples:
            - true
          type: boolean
        key:
          examples:
            - '52998224725'
          type: string
      required:
        - key
        - hasEntry
      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

````