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

> Returns a paginated list of Pix claims for the tenant. X-Account-Id is optional: when provided the listing is scoped to that account (as claimer or donor); when omitted it spans the tenant's full organization-scoped claim set. The role/status/type/key_type filters are repeatable and case-insensitive (OR within a filter, AND across filters). List items omit the per-claim events[]; use get-by-id for the full event history.



## OpenAPI

````yaml /es/openapi/v3-current/pix-lerian-dict.yaml get /claims
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. This release provides a mock-provider integration for
    testing; live BACEN connectivity is not included.
  license:
    name: Lerian Studio General License
  title: Pix Lerian — DICT
  version: 1.0.0
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: Manage ownership and portability claims for Pix keys.
    name: Claims
  - description: Register, retrieve, list, update, and remove Pix keys.
    name: Entries
  - description: Create, query, list, and cancel DICT fraud markers.
    name: Fraud Markers
  - 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: Look up Pix keys and check whether keys exist in the DICT directory.
    name: Keys
  - description: Create, query, cancel, and settle MED 2.0 refunds.
    name: Refunds
paths:
  /claims:
    get:
      tags:
        - Claims
      summary: List Pix key claims
      description: >-
        Returns a paginated list of Pix claims for the tenant. X-Account-Id is
        optional: when provided the listing is scoped to that account (as
        claimer or donor); when omitted it spans the tenant's full
        organization-scoped claim set. The role/status/type/key_type filters are
        repeatable and case-insensitive (OR within a filter, AND across
        filters). List items omit the per-claim events[]; use get-by-id for the
        full event history.
      operationId: listClaims
      parameters:
        - description: >-
            Account UUID (optional). When omitted, lists all of the tenant's
            claims; when provided, scopes the listing to that account.
          in: header
          name: X-Account-Id
          schema:
            description: >-
              Account UUID (optional). When omitted, lists all of the tenant's
              claims; when provided, scopes the listing to that account.
            examples:
              - 019606a1-3b4c-7d8e-9f01-234567890abc
            type: string
        - description: >-
            Filter by the account's role in the claim (repeatable,
            case-insensitive): CLAIMER, DONOR
          explode: true
          in: query
          name: role
          schema:
            description: >-
              Filter by the account's role in the claim (repeatable,
              case-insensitive): CLAIMER, DONOR
            examples:
              - - CLAIMER
            items:
              type: string
            type:
              - array
              - 'null'
        - description: >-
            Filter by claim status (repeatable, case-insensitive): OPEN,
            WAITING_RESOLUTION, CONFIRMED, COMPLETED, CANCELLED
          explode: true
          in: query
          name: status
          schema:
            description: >-
              Filter by claim status (repeatable, case-insensitive): OPEN,
              WAITING_RESOLUTION, CONFIRMED, COMPLETED, CANCELLED
            examples:
              - - OPEN
            items:
              type: string
            type:
              - array
              - 'null'
        - description: >-
            Filter by claim type (repeatable, case-insensitive): PORTABILITY,
            OWNERSHIP
          explode: true
          in: query
          name: type
          schema:
            description: >-
              Filter by claim type (repeatable, case-insensitive): PORTABILITY,
              OWNERSHIP
            examples:
              - - OWNERSHIP
            items:
              type: string
            type:
              - array
              - 'null'
        - description: >-
            Filter by key type (repeatable, case-insensitive): CPF, CNPJ, EMAIL,
            PHONE, EVP
          explode: true
          in: query
          name: key_type
          schema:
            description: >-
              Filter by key type (repeatable, case-insensitive): CPF, CNPJ,
              EMAIL, PHONE, EVP
            examples:
              - - EMAIL
            items:
              type: string
            type:
              - array
              - 'null'
        - description: Filter claims created on or after this date (YYYY-MM-DD)
          explode: false
          in: query
          name: start_date
          schema:
            description: Filter claims created on or after this date (YYYY-MM-DD)
            examples:
              - '2026-05-01'
            type: string
        - description: Filter claims created on or before this date (YYYY-MM-DD)
          explode: false
          in: query
          name: end_date
          schema:
            description: Filter claims created on or before this date (YYYY-MM-DD)
            examples:
              - '2026-05-31'
            type: string
        - description: Page number (1-based, default 1)
          explode: false
          in: query
          name: page
          schema:
            description: Page number (1-based, default 1)
            examples:
              - '1'
            type: string
        - description: Rows per page (default 20, max 100)
          explode: false
          in: query
          name: limit
          schema:
            description: Rows per page (default 20, max 100)
            examples:
              - '20'
            type: string
        - description: Sort direction by createdAt (default desc, case-insensitive)
          explode: false
          in: query
          name: sort_order
          schema:
            description: Sort direction by createdAt (default desc, case-insensitive)
            examples:
              - desc
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListClaimsOutput'
          description: OK
        '400':
          content:
            application/problem+json:
              example:
                type: https://errors.lerian.studio/v1/PIX-0001
                title: Bad Request
                status: 400
                detail: Your request is missing one or more required header params.
                code: PIX-0001
              schema:
                $ref: '#/components/schemas/Detail'
          description: >-
            Bad Request (PIX-0001, PIX-0002, PIX-0003, PIX-0017, PIX-0015,
            PIX-0020, PIX-0142, PIX-0143).
        '404':
          content:
            application/problem+json:
              example:
                type: https://errors.lerian.studio/v1/PIX-0145
                title: Not Found
                status: 404
                detail: No claim was found for the given identifier and account.
                code: PIX-0145
              schema:
                $ref: '#/components/schemas/Detail'
          description: Not Found (PIX-0145).
        '409':
          content:
            application/problem+json:
              example:
                type: https://errors.lerian.studio/v1/PIX-0144
                title: Conflict
                status: 409
                detail: >-
                  The X-Request-Id was already seen with a different request
                  body.
                code: PIX-0144
              schema:
                $ref: '#/components/schemas/Detail'
          description: Conflict (PIX-0144).
        '422':
          content:
            application/problem+json:
              example:
                type: https://errors.lerian.studio/v1/PIX-0146
                title: Unprocessable Entity
                status: 422
                detail: >-
                  The requested claim type and key type combination is not
                  supported.
                code: PIX-0146
              schema:
                $ref: '#/components/schemas/Detail'
          description: >-
            Unprocessable Entity (PIX-0146, PIX-0147, PIX-0149, PIX-0163,
            PIX-0165, PIX-0166, PIX-0167, PIX-0168, PIX-0171, PIX-0172,
            PIX-0173, PIX-0116).
        '429':
          content:
            application/problem+json:
              example:
                type: https://errors.lerian.studio/v1/PIX-0148
                title: Too Many Requests
                status: 429
                detail: The rate limit for this claim operation has been exceeded.
                code: PIX-0148
              schema:
                $ref: '#/components/schemas/Detail'
          description: Too Many Requests (PIX-0148).
        '500':
          content:
            application/problem+json:
              example:
                type: https://errors.lerian.studio/v1/PIX-0000
                title: Internal Server Error
                status: 500
                detail: internal error
                code: PIX-0000
              schema:
                $ref: '#/components/schemas/Detail'
          description: Internal Server Error (PIX-0000).
        '502':
          content:
            application/problem+json:
              example:
                type: https://errors.lerian.studio/v1/PIX-0140
                title: Bad Gateway
                status: 502
                detail: internal error
                code: PIX-0140
              schema:
                $ref: '#/components/schemas/Detail'
          description: Bad Gateway (PIX-0140).
        '503':
          content:
            application/problem+json:
              example:
                type: https://errors.lerian.studio/v1/PIX-0164
                title: Service Unavailable
                status: 503
                detail: internal error
                code: PIX-0164
              schema:
                $ref: '#/components/schemas/Detail'
          description: Service Unavailable (PIX-0164).
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
components:
  schemas:
    ListClaimsOutput:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/ClaimOutput'
          type:
            - array
            - 'null'
        limit:
          examples:
            - 20
          format: int64
          type: integer
        page:
          examples:
            - 1
          format: int64
          type: integer
        total:
          examples:
            - 1
          format: int64
          type: integer
      required:
        - items
        - total
        - page
        - limit
      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
    ClaimOutput:
      additionalProperties: false
      properties:
        accountId:
          examples:
            - 019606a1-3b4c-7d8e-9f01-234567890abc
          type: string
        bacenId:
          examples:
            - claim-bacen-001
          type: string
        cancelReason:
          type: string
        cancelledBy:
          type: string
        claimId:
          examples:
            - 019606c3-5d6e-7f80-1b23-456789012cde
          type: string
        claimer:
          $ref: '#/components/schemas/ClaimClaimerOutput'
        completionPeriodEnd:
          examples:
            - '2026-06-18T03:00:00Z'
          type: string
        confirmReason:
          type: string
        correlationId:
          examples:
            - a9f13566e19f5ca51329479a5bae60c5
          type: string
        createdAt:
          examples:
            - '2026-05-19T14:30:00Z'
          type: string
        donorParticipant:
          examples:
            - '12345678'
          type: string
        keyType:
          examples:
            - PHONE
          type: string
        keyValue:
          examples:
            - '+5511987659999'
          type: string
        lastModified:
          examples:
            - '2026-05-19T14:32:11Z'
          type: string
        requestId:
          examples:
            - e7c1a2b3-4d5e-6f70-8a90-1b2c3d4e5f60
          type: string
        resolutionPeriodEnd:
          examples:
            - '2026-05-25T03:00:00Z'
          type: string
        status:
          examples:
            - WAITING_RESOLUTION
          type: string
        type:
          examples:
            - PORTABILITY
          type: string
        updatedAt:
          examples:
            - '2026-05-19T14:32:11Z'
          type: string
      required:
        - claimId
        - accountId
        - bacenId
        - status
        - type
        - keyType
        - keyValue
        - donorParticipant
        - claimer
        - lastModified
        - createdAt
        - updatedAt
      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
    ClaimClaimerOutput:
      additionalProperties: false
      properties:
        account:
          $ref: '#/components/schemas/ClaimClaimerAccountOutput'
        document:
          examples:
            - '52998224725'
          type: string
        name:
          examples:
            - Maria da Silva
          type: string
        participant:
          examples:
            - '87654321'
          type: string
        personType:
          examples:
            - NATURAL_PERSON
          type: string
        tradeName:
          examples:
            - Silva ME
          type: string
      required:
        - participant
      type: object
    ClaimClaimerAccountOutput:
      additionalProperties: false
      properties:
        branch:
          examples:
            - '0001'
          type: string
        number:
          examples:
            - '1234567'
          type: string
        openingDate:
          examples:
            - '2024-03-10'
          type: string
        type:
          examples:
            - CACC
          type: string
      required:
        - branch
        - number
        - type
        - openingDate
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: JWT bearer token issued by the identity provider.
      scheme: bearer
      type: http

````