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

# List PIX key entries

> Lists the PIX keys of the account named by account_id. The response is not a table read: it is rebuilt on every call by merging three sources - the live DICT directory listing for the account (§8.2.06, every key reported as ACTIVE), the plugin's own local key rows (whose status is only a hint), and the account's in-flight DICT claims (§8.2.08), all projected onto the same eKeyStatus enum. Rows are keyed by the key VALUE: a directory key wins over a local row for the same value, and a live claim overrides both, because claim state is authoritative at DICT.

Nothing is written back, so the three sources never reconcile. A local row for a key DICT no longer holds keeps appearing with its stale status until the directory or a claim overrides it, and a key that exists only at DICT appears with no claimId and no local history. There is no filter and no pagination, and the claims source reads only the FIRST §8.2.08 page (100 rows), so an account with more in-flight claims than that is silently short. If any one of the three sources fails the whole request fails - the listing is never partial. account_id is required (omitting it is refused by schema validation; a blank value is 400 PIX-0061), and an account the CRM cannot resolve is 404 PIX-2016.



## OpenAPI

````yaml /en/openapi/v3-current/pix.yaml get /v1/entries
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:
    get:
      tags:
        - Entries
      summary: List PIX key entries
      description: >-
        Lists the PIX keys of the account named by account_id. The response is
        not a table read: it is rebuilt on every call by merging three sources -
        the live DICT directory listing for the account (§8.2.06, every key
        reported as ACTIVE), the plugin's own local key rows (whose status is
        only a hint), and the account's in-flight DICT claims (§8.2.08), all
        projected onto the same eKeyStatus enum. Rows are keyed by the key
        VALUE: a directory key wins over a local row for the same value, and a
        live claim overrides both, because claim state is authoritative at DICT.


        Nothing is written back, so the three sources never reconcile. A local
        row for a key DICT no longer holds keeps appearing with its stale status
        until the directory or a claim overrides it, and a key that exists only
        at DICT appears with no claimId and no local history. There is no filter
        and no pagination, and the claims source reads only the FIRST §8.2.08
        page (100 rows), so an account with more in-flight claims than that is
        silently short. If any one of the three sources fails the whole request
        fails - the listing is never partial. account_id is required (omitting
        it is refused by schema validation; a blank value is 400 PIX-0061), and
        an account the CRM cannot resolve is 404 PIX-2016.
      operationId: getEntries
      parameters:
        - description: The CRM account id whose keys to list.
          explode: false
          in: query
          name: account_id
          required: true
          schema:
            description: The CRM account id whose keys to list.
            examples:
              - acc-123
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntryListBody'
          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:
    EntryListBody:
      additionalProperties: false
      properties:
        data:
          description: The list of key entries.
          items:
            $ref: '#/components/schemas/EntryView'
          type:
            - array
            - 'null'
      required:
        - data
      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
    EntryView:
      additionalProperties: false
      properties:
        claimId:
          description: Associated claim id, when the key is in a claim flow.
          examples:
            - claim-123
          type: string
        ispb:
          description: ISPB of the participant holding the key, when reconstructed.
          examples:
            - '12345678'
          type: string
        key:
          description: The PIX key value.
          examples:
            - '11122233300'
          type: string
        status:
          description: Numeric eKeyStatus (-1..7).
          examples:
            - 1
          format: int64
          type: integer
        statusDescription:
          description: Human-readable eKeyStatus label.
          examples:
            - ACTIVE
          type: string
        type:
          description: Numeric eKeyType (0=CPF,1=CNPJ,2=EMAIL,3=PHONE,4=RANDOM).
          examples:
            - 0
          format: int64
          type: integer
      required:
        - key
        - status
        - statusDescription
        - type
        - claimId
        - ispb
      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

````