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

# Get PIX key entry details

> Resolves what DICT holds behind a PIX key - the payee document and name, the key type, the holder ISPB and an end-to-end id (§8.2.14 Consultar Chave de Endereçamento). entryId is the key VALUE, URL-encoded; account_id is the caller's CRM account.

It is a SELF-lookup, not a directory search, and the shape does not show it: after the DICT read the service compares the payee document DICT returned against the caller's own account document and refuses the response with 422 PIX-0086 when they differ. A CPF or CNPJ key that is not the caller's own document is refused the same way BEFORE DICT is called. The only key this route will describe is therefore one whose holder document equals yours - it cannot be used to resolve a counterparty ahead of a payment. An account_id the CRM cannot resolve is 404 PIX-0063 here (not the PIX-2016 the sibling key routes answer), and a key DICT does not hold is 404 PIX-1011.



## OpenAPI

````yaml /en/openapi/v3-current/pix.yaml get /v1/entries/{entryId}/details
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/{entryId}/details:
    get:
      tags:
        - Entries
      summary: Get PIX key entry details
      description: >-
        Resolves what DICT holds behind a PIX key - the payee document and name,
        the key type, the holder ISPB and an end-to-end id (§8.2.14 Consultar
        Chave de Endereçamento). entryId is the key VALUE, URL-encoded;
        account_id is the caller's CRM account.


        It is a SELF-lookup, not a directory search, and the shape does not show
        it: after the DICT read the service compares the payee document DICT
        returned against the caller's own account document and refuses the
        response with 422 PIX-0086 when they differ. A CPF or CNPJ key that is
        not the caller's own document is refused the same way BEFORE DICT is
        called. The only key this route will describe is therefore one whose
        holder document equals yours - it cannot be used to resolve a
        counterparty ahead of a payment. An account_id the CRM cannot resolve is
        404 PIX-0063 here (not the PIX-2016 the sibling key routes answer), and
        a key DICT does not hold is 404 PIX-1011.
      operationId: entryDetails
      parameters:
        - description: The PIX key value (URL-encoded).
          in: path
          name: entryId
          required: true
          schema:
            description: The PIX key value (URL-encoded).
            examples:
              - foo@bar.com
            type: string
        - description: The CRM account id of the caller.
          explode: false
          in: query
          name: account_id
          required: true
          schema:
            description: The CRM account id of the caller.
            examples:
              - acc-123
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntryDetailsResponse'
          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:
    EntryDetailsResponse:
      additionalProperties: false
      properties:
        endToEndId:
          description: The SPI end-to-end identifier.
          examples:
            - E1234567890
          type: string
        key:
          description: The PIX key value.
          examples:
            - foo@bar.com
          type: string
        payee:
          $ref: '#/components/schemas/EntryPayee'
          description: The resolved recipient bank data.
      required:
        - key
        - endToEndId
        - payee
      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
    EntryPayee:
      additionalProperties: false
      properties:
        document:
          description: Recipient document (CPF/CNPJ).
          examples:
            - '12345678909'
          type: string
        ispb:
          description: Recipient participant ISPB.
          examples:
            - '12345678'
          type: string
        key:
          description: The resolved PIX key.
          examples:
            - foo@bar.com
          type: string
        name:
          description: Recipient holder name.
          examples:
            - Jane Doe
          type: string
      required:
        - document
        - name
        - ispb
        - key
      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

````