> ## 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 Pix Key

> Use this endpoint to retrieve Pix key details for payment purposes.



## OpenAPI

````yaml /pt/openapi/v3-current/indirect-pix.yaml get /v1/dict/keys/{key}
openapi: 3.1.0
info:
  contact:
    email: contact@lerian.studio
    name: Lerian Studio
    url: https://lerian.studio
  description: >-
    API for Pix Indirect via BTG. It covers DICT keys and claims; MED infraction
    reports, fraud markers, refund requests, and funds recoveries; DICT
    statistics and reconciliation; Pix transfers, refunds, and schedules; static
    QR codes and QR code decoding; immediate and due-date collections; Pix
    Automático for the payer; transaction reports and TemposTransacoes
    statistics; and inbound and outbound webhook records.
  license:
    name: Lerian Studio General License
  title: Pix BTG API
  version: 1.14.0
servers:
  - url: https://api.example.com
    description: >-
      Replace the example host with the URL provided during environment
      onboarding.
security:
  - BearerAuth: []
paths:
  /v1/dict/keys/{key}:
    get:
      tags:
        - Keys
      summary: Retrieve a Pix Key
      description: Use this endpoint to retrieve Pix key details for payment purposes.
      operationId: dict-get-key
      parameters:
        - description: Pix key value (CPF, CNPJ, Email, or Phone)
          in: path
          name: key
          required: true
          schema:
            description: Pix key value (CPF, CNPJ, Email, or Phone)
            type: string
        - description: Account ID (UUID format)
          in: header
          name: X-Account-Id
          required: true
          schema:
            description: Account ID (UUID format)
            format: uuid
            type: string
        - description: End-to-end transaction identifier
          in: header
          name: X-End-To-End-Id
          required: true
          schema:
            description: End-to-end transaction identifier
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetKeyOutput'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LegacyErrorBody'
          description: Bad Request
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LegacyErrorBody'
          description: Internal Server Error
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LegacyErrorBody'
          description: Error
components:
  schemas:
    GetKeyOutput:
      additionalProperties: false
      properties:
        account:
          $ref: '#/components/schemas/AccountOutput'
          description: Account information associated with this PIX key
        creationDate:
          description: When this PIX key entry was created
          examples:
            - '2024-01-15T10:30:00Z'
          format: date-time
          type: string
        endToEndId:
          description: Unique identifier for the end-to-end transaction tracking
          examples:
            - 550e8400-e29b-41d4-a716-446655440003
          type: string
        key:
          description: PIX key value that was registered
          examples:
            - john.doe@example.com
          type: string
        keyOwnershipDate:
          description: When the customer became the owner of this PIX key
          examples:
            - '2024-01-15T10:30:00Z'
          format: date-time
          type: string
        keyType:
          description: Type of this PIX key
          enum:
            - CPF
            - CNPJ
            - EMAIL
            - PHONE
          examples:
            - EMAIL
          type: string
        owner:
          $ref: '#/components/schemas/OwnerOutput'
          description: Owner information associated with this PIX key
      required:
        - endToEndId
        - key
        - keyType
        - account
        - owner
        - creationDate
        - keyOwnershipDate
      type: object
    LegacyErrorBody:
      additionalProperties: false
      properties:
        code:
          type: string
        fields:
          additionalProperties:
            type: string
          type: object
        headers:
          additionalProperties:
            type: string
          type: object
        message:
          type: string
        paths:
          additionalProperties:
            type: string
          type: object
        queryParams:
          additionalProperties:
            type: string
          type: object
        raw:
          type: string
        title:
          type: string
      required:
        - code
        - title
        - message
      type: object
    AccountOutput:
      additionalProperties: false
      properties:
        branch:
          description: Bank branch code where the account is held (4 digits)
          examples:
            - '0001'
          type: string
        id:
          description: Unique identifier of the customer account
          examples:
            - 550e8400-e29b-41d4-a716-446655440000
          type: string
        number:
          description: >-
            Unique account number at the institution, as sent to DICT: 1-20
            uppercase letters or digits, ending in a digit
          examples:
            - '123456789'
          type: string
        openingDate:
          description: Date when the account was opened
          examples:
            - '2020-01-15T10:30:00Z'
          format: date-time
          type: string
        participant:
          description: >-
            ISPB of the participant institution (8 uppercase alphanumeric
            characters)
          examples:
            - '12345678'
          type: string
        type:
          description: Kind of account holding this Pix key
          enum:
            - CACC
            - SLRY
            - SVGS
            - TRAN
            - OTHR
          examples:
            - TRAN
          type: string
      required:
        - id
        - participant
        - branch
        - number
        - type
        - openingDate
      type: object
    OwnerOutput:
      additionalProperties: false
      properties:
        document:
          description: Identification document of the account owner (CPF or CNPJ)
          examples:
            - '52998224725'
          type: string
        name:
          description: Full name or registered name of the account owner
          examples:
            - John Doe
          type: string
        tradeName:
          description: Business trade name or commercial alias
          examples:
            - John's Business
          type: string
        type:
          description: Whether the account owner is a person or organization
          enum:
            - NATURAL_PERSON
            - LEGAL_PERSON
          examples:
            - NATURAL_PERSON
          type: string
      required:
        - type
        - document
        - name
        - tradeName
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: JWT bearer token issued by the identity provider.
      scheme: bearer
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.