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

# Verify PIX key existence

> Bulk-checks whether each supplied PIX key exists in the DICT directory (§8.2.23 Verificar Existência de Chaves). accountId resolves the caller's ISPB only - it does not scope the answer - and keys carries 1 to 200 values; a batch outside those bounds is refused before any DICT call, with 400 PIX-0061 naming keys.

What comes back is existence and nothing else: each row is a key plus an exists flag. It does not say who holds a key, whether YOU hold it, or whether it can be claimed, so it is not the pre-check for a claim - POST /v1/entries is, because that is what turns a key DICT already knows into the claim-pending row POST /v1/claims requires. Use this to sift a list of keys, for example before a batch payout. The response also echoes DICT's own jdpiReturnedAt and correlationId, which are the values support asks for.



## OpenAPI

````yaml /en/openapi/v3-current/pix.yaml post /v1/entries/verification
openapi: 3.1.0
info:
  description: Brazilian PIX Direct (DICT + SPI) plugin API.
  title: plugin-br-pix-jd
  version: 1.0.0
servers: []
security:
  - BearerAuth: []
paths:
  /v1/entries/verification:
    post:
      tags:
        - Entries
      summary: Verify PIX key existence
      description: >-
        Bulk-checks whether each supplied PIX key exists in the DICT directory
        (§8.2.23 Verificar Existência de Chaves). accountId resolves the
        caller's ISPB only - it does not scope the answer - and keys carries 1
        to 200 values; a batch outside those bounds is refused before any DICT
        call, with 400 PIX-0061 naming keys.


        What comes back is existence and nothing else: each row is a key plus an
        exists flag. It does not say who holds a key, whether YOU hold it, or
        whether it can be claimed, so it is not the pre-check for a claim - POST
        /v1/entries is, because that is what turns a key DICT already knows into
        the claim-pending row POST /v1/claims requires. Use this to sift a list
        of keys, for example before a batch payout. The response also echoes
        DICT's own jdpiReturnedAt and correlationId, which are the values
        support asks for.
      operationId: verifyEntries
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VerifyEntriesBody'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VerifyEntriesResponse'
          description: OK
        '422':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Unprocessable Entity
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Internal Server Error
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
components:
  schemas:
    VerifyEntriesBody:
      additionalProperties: false
      properties:
        accountId:
          description: The CRM account id of the caller (resolves the server-side ISPB).
          examples:
            - acc-123
          type: string
        keys:
          description: The PIX keys whose DICT existence to check (1..200).
          examples:
            - - foo@bar.com
              - '11122233300'
          items:
            type: string
          maxItems: 200
          minItems: 1
          type: array
      required:
        - accountId
        - keys
      type: object
    VerifyEntriesResponse:
      additionalProperties: false
      properties:
        correlationId:
          description: DICT support correlation id.
          examples:
            - a9f13566e19f5ca51329479a5bae60c5
          type: string
        jdpiReturnedAt:
          description: When DICT returned the verification (RFC3339).
          examples:
            - '2021-04-08T10:30:05.025Z'
          type: string
        keys:
          description: The per-key existence results.
          items:
            $ref: '#/components/schemas/VerifiedKeyView'
          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
    VerifiedKeyView:
      additionalProperties: false
      properties:
        exists:
          description: Whether the key exists in DICT.
          examples:
            - true
          type: boolean
        key:
          description: The PIX key value.
          examples:
            - foo@bar.com
          type: string
      required:
        - key
        - exists
      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

````