> ## 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 a Pix key entry

> Retrieves a Pix entry by its unique identifier, scoped to the calling account.



## OpenAPI

````yaml en/openapi/v3-current/pix-lerian-dict.yaml GET /entries/{entry_id}
openapi: 3.1.0
info:
  contact:
    name: Lerian Studio
    url: https://lerian.studio
  description: >-
    Public API for Pix keys, claims, fraud markers, infraction reports, and MED
    funds recovery.
  license:
    name: Elastic License 2.0
    url: https://www.elastic.co/licensing/elastic-license
  title: Pix Lerian — DICT
  version: release-candidate
servers:
  - url: https://api.example.com/dict-hub/v1
    description: >-
      Replace the example host with the URL provided during environment
      onboarding.
security:
  - BearerAuth: []
tags:
  - description: Register, retrieve, list, update, and remove Pix keys.
    name: Entries
  - description: Look up Pix keys and check whether keys exist in the DICT directory.
    name: Keys
  - description: Manage ownership and portability claims for Pix keys.
    name: Claims
  - description: Manage participant-scoped MED 2.0 funds recoveries.
    name: Funds Recoveries
  - description: Manage MED 2.0 infraction reports for the authenticated organization.
    name: Infraction Reports
  - description: Create, query, cancel, and settle MED 2.0 refunds.
    name: Refunds
  - description: Create, query, list, and cancel DICT fraud markers.
    name: Fraud Markers
paths:
  /entries/{entry_id}:
    get:
      tags:
        - Entries
      summary: Get a Pix key entry
      description: >-
        Retrieves a Pix entry by its unique identifier, scoped to the calling
        account.
      operationId: getEntry
      parameters:
        - description: Entry ID (UUID format)
          in: path
          name: entry_id
          required: true
          schema:
            description: Entry ID (UUID format)
            examples:
              - 019606c3-5d6e-7f80-1b23-456789012cde
            type: string
          example: 019606d4-6e7f-8091-2c34-567890123def
        - description: UUID of the account associated with the operation.
          in: header
          name: X-Account-Id
          required: true
          schema:
            description: UUID of the account associated with the operation.
            examples:
              - 019606a1-3b4c-7d8e-9f01-234567890abc
            type: string
          example: 019606a1-3b4c-7d8e-9f01-234567890abc
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetEntryOutput'
              examples:
                fictitiousExample:
                  summary: Fictitious example
                  value:
                    account:
                      branch: '0001'
                      number: '0007654321'
                      openingDate: '2010-01-10T03:00:00Z'
                      participant: '12345678'
                      type: CACC
                    createdAt: '2019-11-18T03:00:00Z'
                    holderId: 019606e5-7f80-9102-3d45-678901234ef0
                    id: 019606c3-5d6e-7f80-1b23-456789012cde
                    keyCreationDate: '2019-11-18T03:00:00Z'
                    keyOwnershipDate: '2019-11-18T03:00:00Z'
                    keyType: CPF
                    keyValue: '52998224725'
                    metadata:
                      field: field-example
                    organizationId: 019606d4-6e7f-8091-2c34-567890123def
                    owner:
                      document: '52998224725'
                      name: João Silva
                      personType: NATURAL
                      tradeName: Silva ME
                    requestId: a946d533-7f22-42a5-9a9b-e87cd55c0f4d
                    status: ACTIVE
                    updatedAt: '2019-11-18T03:00:00Z'
          description: OK
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
      x-codeSamples:
        - lang: bash
          label: cURL with fictitious data
          source: |-
            curl --request GET \
              --url https://api.example.com/dict-hub/v1/entries/019606d4-6e7f-8091-2c34-567890123def \
              --header 'Authorization: Bearer demo-access-token' \
              --header 'X-Account-Id: 019606a1-3b4c-7d8e-9f01-234567890abc'
components:
  schemas:
    GetEntryOutput:
      additionalProperties: false
      properties:
        account:
          $ref: '#/components/schemas/EntryAccountOutput'
        createdAt:
          examples:
            - '2019-11-18T03:00:00Z'
          format: date-time
          type: string
        holderId:
          examples:
            - 019606e5-7f80-9102-3d45-678901234ef0
          type: string
        id:
          examples:
            - 019606c3-5d6e-7f80-1b23-456789012cde
          type: string
        keyCreationDate:
          examples:
            - '2019-11-18T03:00:00Z'
          format: date-time
          type: string
        keyOwnershipDate:
          examples:
            - '2019-11-18T03:00:00Z'
          format: date-time
          type: string
        keyType:
          examples:
            - CPF
          type: string
        keyValue:
          examples:
            - '52998224725'
          type: string
        metadata:
          additionalProperties: {}
          type: object
        organizationId:
          examples:
            - 019606d4-6e7f-8091-2c34-567890123def
          type: string
        owner:
          $ref: '#/components/schemas/EntryOwnerOutput'
        requestId:
          examples:
            - a946d533-7f22-42a5-9a9b-e87cd55c0f4d
          type: string
        status:
          examples:
            - ACTIVE
          type: string
        updatedAt:
          examples:
            - '2019-11-18T03:00:00Z'
          format: date-time
          type: string
      required:
        - id
        - organizationId
        - holderId
        - keyType
        - keyValue
        - status
        - requestId
        - keyCreationDate
        - keyOwnershipDate
        - account
        - owner
        - createdAt
        - updatedAt
      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
    EntryAccountOutput:
      additionalProperties: false
      properties:
        branch:
          examples:
            - '0001'
          type: string
        number:
          examples:
            - '0007654321'
          type: string
        openingDate:
          examples:
            - '2010-01-10T03:00:00Z'
          format: date-time
          type: string
        participant:
          examples:
            - '12345678'
          type: string
        type:
          examples:
            - CACC
          type: string
      required:
        - branch
        - number
        - type
        - participant
      type: object
    EntryOwnerOutput:
      additionalProperties: false
      properties:
        document:
          examples:
            - '52998224725'
          type: string
        name:
          examples:
            - João Silva
          type: string
        personType:
          examples:
            - NATURAL
          type: string
        tradeName:
          examples:
            - Silva ME
          type: string
      required:
        - document
        - personType
        - name
      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

````