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

# Retrieve a Key

> Use this endpoint to retrieve Pix key details for payment purposes. This
operation queries the DICT system to get account information associated
with a Pix key, enabling you to validate and prepare payment
destinations.



## OpenAPI

````yaml /en/openapi/v3-current/indirect-pix.yaml get /v1/dict/keys/{key}
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/{key}:
    get:
      tags:
        - DICT API
      summary: Retrieve a Key
      description: |-
        Use this endpoint to retrieve Pix key details for payment purposes. This
        operation queries the DICT system to get account information associated
        with a Pix key, enabling you to validate and prepare payment
        destinations.
      parameters:
        - $ref: '#/components/parameters/KeyPath'
        - $ref: '#/components/parameters/XAccountId'
        - $ref: '#/components/parameters/XEndToEndId'
      responses:
        '200':
          description: Pix key details retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetKeyOutput'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorFormat'
              examples:
                ErrorPIX0001:
                  $ref: '#/components/examples/ErrorPIX0001'
                ErrorPIX0002:
                  $ref: '#/components/examples/ErrorPIX0002'
                ErrorPIX0008:
                  $ref: '#/components/examples/ErrorPIX0008'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorFormat'
              examples:
                ErrorPIX1005:
                  $ref: '#/components/examples/ErrorPIX1005'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorFormat'
              examples:
                ErrorPIX0114:
                  $ref: '#/components/examples/ErrorPIX0114'
        '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:
  parameters:
    KeyPath:
      name: key
      in: path
      description: Pix key value (CPF, CNPJ, Email, Phone, or EVP).
      required: true
      example: john.doe@example.com
      schema:
        type: string
    XAccountId:
      name: X-Account-Id
      in: header
      description: Unique identifier of the Midaz Ledger Account (UUID format).
      required: true
      example: 019c96a0-0a98-7287-9a31-786e0809c769
      schema:
        type: string
    XEndToEndId:
      name: X-EndToEnd-Id
      in: header
      description: Optional SPI end-to-end identifier used for payment proposals.
      required: false
      example: E123456789BR1234567890123456789
      schema:
        type: string
  schemas:
    GetKeyOutput:
      type: object
      properties:
        key:
          type: string
          description: Pix key value.
          example: john.doe@example.com
        keyType:
          type: string
          description: Type of Pix key.
          example: EMAIL
        account:
          $ref: '#/components/schemas/AccountDetails'
        owner:
          $ref: '#/components/schemas/OwnerDetails'
    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.
    AccountDetails:
      type: object
      properties:
        branch:
          type: string
          description: Bank branch code.
          example: '0001'
        number:
          type: string
          description: Account number.
          example: '123456789'
        participant:
          type: string
          description: ISPB of the participant institution.
          example: '12345678'
        type:
          type: string
          description: Account type.
          example: TRAN
    OwnerDetails:
      type: object
      properties:
        name:
          type: string
          description: Owner name.
          example: John Doe
        taxIdNumber:
          type: string
          description: CPF or CNPJ.
          example: '12345678901'
        type:
          type: string
          enum:
            - NATURAL_PERSON
            - LEGAL_PERSON
          description: Owner type.
          example: NATURAL_PERSON
  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.
    ErrorPIX0002:
      summary: Invalid Header Value
      value:
        code: PIX-0002
        title: Invalid Header Value
        message: >-
          One or more header values are invalid. Please refer to the
          documentation to verify the expected format and allowed values for
          each header.
    ErrorPIX0008:
      summary: Invalid Path Parameter in Request
      value:
        code: PIX-0008
        title: Invalid Path Parameter in Request
        message: >-
          One or more path parameters are invalid. Please refer to the
          documentation to verify the expected format and allowed values for
          each path parameter.
    ErrorPIX1005:
      summary: Key Not Found
      value:
        code: PIX-1005
        title: Key Not Found
        message: The Pix key was not found.
    ErrorPIX0114:
      summary: Key In Custody Account
      value:
        code: PIX-0114
        title: Key In Custody Account
        message: The entry queried is in custody of the participant making the query.
    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

````