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

# Batch check PIX key existence

> Probes up to 200 PIX key values for existence in one call, backed by the BACEN DICT keys/check (dict-np host). Returns one existence-only result per submitted key, in submission order. Requires the dict-np endpoint; a 503 is returned when it is unconfigured.



## OpenAPI

````yaml en/openapi/v3-current/spi-dict.yaml post /api/v1/dict/keys/check
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, infraction reports,
    refunds, fraud markers, synchronous DICT reports, and the internal
    reconciliation and provisioning 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://spi.sandbox.lerian.net
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: create, 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: >-
      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: >-
      Internal DICT operations: reconciliation runs, participant ISPB
      provisioning, claim deadline processing, and orphaned-key cleanup.
    name: Internal
paths:
  /api/v1/dict/keys/check:
    post:
      tags:
        - Keys
      summary: Batch check PIX key existence
      description: >-
        Probes up to 200 PIX key values for existence in one call, backed by the
        BACEN DICT keys/check (dict-np host). Returns one existence-only result
        per submitted key, in submission order. Requires the dict-np endpoint; a
        503 is returned when it is unconfigured.
      operationId: checkKeys
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CheckKeysRequest'
              description: >-
                Up to 200 PIX key values to probe for existence in one batch
                (backed by BACEN dict-np keys/check); response is existence-only
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CheckKeysResponse'
                description: One existence result per submitted key, in submission order
          description: OK
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
      security:
        - BearerAuth: []
components:
  schemas:
    CheckKeysRequest:
      additionalProperties: false
      properties:
        keys:
          description: PIX key values to probe for existence (1..200 per batch).
          items:
            type: string
          maxItems: 200
          minItems: 1
          type:
            - array
            - 'null'
      required:
        - keys
      type: object
    CheckKeysResponse:
      additionalProperties: false
      properties:
        results:
          description: One existence result per submitted key, in submission order.
          items:
            $ref: '#/components/schemas/CheckKeyResult'
          type:
            - array
            - 'null'
      required:
        - results
      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
      type: object
    CheckKeyResult:
      additionalProperties: false
      properties:
        hasEntry:
          description: Whether the key has a DICT entry.
          examples:
            - true
          type: boolean
        key:
          description: The submitted PIX key value.
          examples:
            - '12345678901'
          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
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: JWT bearer token issued by the identity provider.
      scheme: bearer
      type: http

````