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

> Two different listings behind one route, selected by the status query parameter.

With no status (the default) it returns DICT's §8.2.13 claim listing for the PARTICIPANT, not for the account: account_id only resolves the caller's ISPB, and the request body carries that ISPB and nothing else, so every claim DICT associates with the institution comes back - including claims that belong to OTHER accounts under the same ISPB. There is no filter, no paging and no local sort. Two consequences follow from the omitted fields: §8.2.13 declares that an omitted stReivindicacao defaults to situation 1 (Aguardando Resolução), so claims in other situations may not appear; and each row is only key, ispb and claimId, with no state, because DICT's situation value cannot be projected onto this API's status enum without losing cases.

With status=processing it answers something else entirely - the in-flight claims of §8.2.08, filtered to the caller's own account number, projected onto the key-entry shape and returned under data instead of claims. The projected status is 5 (you are waiting for the holder), 6 (you hold the key and must decide) or 7 (the holder gave it away; conclude it). Cancelled and completed claims are dropped, and only the FIRST §8.2.08 page (100 rows) is read. Any other status value falls through to the default branch. An account the CRM cannot resolve is 404 PIX-2016.



## OpenAPI

````yaml /en/openapi/v3-current/pix.yaml get /v1/claims
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/claims:
    get:
      tags:
        - Claims
      summary: List PIX key claims
      description: >-
        Two different listings behind one route, selected by the status query
        parameter.


        With no status (the default) it returns DICT's §8.2.13 claim listing for
        the PARTICIPANT, not for the account: account_id only resolves the
        caller's ISPB, and the request body carries that ISPB and nothing else,
        so every claim DICT associates with the institution comes back -
        including claims that belong to OTHER accounts under the same ISPB.
        There is no filter, no paging and no local sort. Two consequences follow
        from the omitted fields: §8.2.13 declares that an omitted
        stReivindicacao defaults to situation 1 (Aguardando Resolução), so
        claims in other situations may not appear; and each row is only key,
        ispb and claimId, with no state, because DICT's situation value cannot
        be projected onto this API's status enum without losing cases.


        With status=processing it answers something else entirely - the
        in-flight claims of §8.2.08, filtered to the caller's own account
        number, projected onto the key-entry shape and returned under data
        instead of claims. The projected status is 5 (you are waiting for the
        holder), 6 (you hold the key and must decide) or 7 (the holder gave it
        away; conclude it). Cancelled and completed claims are dropped, and only
        the FIRST §8.2.08 page (100 rows) is read. Any other status value falls
        through to the default branch. An account the CRM cannot resolve is 404
        PIX-2016.
      operationId: getClaims
      parameters:
        - description: The CRM account id whose claims to list.
          explode: false
          in: query
          name: account_id
          required: true
          schema:
            description: The CRM account id whose claims to list.
            examples:
              - acc-123
            type: string
        - description: >-
            Set to 'processing' to list in-flight claims as key entries instead
            of claims.
          explode: false
          in: query
          name: status
          schema:
            description: >-
              Set to 'processing' to list in-flight claims as key entries
              instead of claims.
            examples:
              - processing
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetClaimsBody'
          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:
    GetClaimsBody:
      additionalProperties: false
      properties:
        claims:
          description: The list of claims (default branch).
          items:
            $ref: '#/components/schemas/ClaimListItem'
          type:
            - array
            - 'null'
        data:
          description: The in-flight claims as key entries (?status=processing branch).
          items:
            $ref: '#/components/schemas/EntryView'
          type:
            - array
            - 'null'
      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
    ClaimListItem:
      additionalProperties: false
      properties:
        claimId:
          description: The claim id.
          examples:
            - claim-123
          type: string
        ispb:
          description: The participant ISPB.
          examples:
            - '12345678'
          type: string
        key:
          description: The PIX key value.
          examples:
            - '11122233300'
          type: string
      required:
        - key
        - ispb
        - claimId
      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

````