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

> Retrieve all claims associated with an account. Optionally filter by claim status string values
(OPEN, CONFIRMED, COMPLETED, CANCELLED, AWAITING_RESOLUTION).




## OpenAPI

````yaml en/openapi/v3-current/pix.yaml GET /v1/claims
openapi: 3.0.3
info:
  title: Plugin BR Pix Direct - Complete API
  description: |
    Complete API for Brazilian Pix instant payment system including
    Pix key dictionary operations, QR code generation/decoding, transactions and
    transaction limits.
  version: 1.0.0
servers:
  - url: https://plugin-pix-direct.api.lerian.net
  - url: https://plugin-pix-direct-qrcode.api.lerian.net
security:
  - bearerAuth: []
paths:
  /v1/claims:
    get:
      tags:
        - Key Claims API
      summary: List claims
      description: >
        Retrieve all claims associated with an account. Optionally filter by
        claim status string values

        (OPEN, CONFIRMED, COMPLETED, CANCELLED, AWAITING_RESOLUTION).
      parameters:
        - $ref: '#/components/parameters/AccountIdQuery'
        - name: status
          in: query
          required: false
          description: >
            Filter by claim status. Possible values: OPEN, CONFIRMED, COMPLETED,
            CANCELLED, AWAITING_RESOLUTION.
          schema:
            type: string
          example: OPEN
      responses:
        '200':
          description: List of claims retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClaimListResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  parameters:
    AccountIdQuery:
      name: account_id
      in: query
      required: false
      description: Account identifier.
      schema:
        type: string
        format: uuid
      example: 019c96a0-0a98-7287-9a31-786e0809c769
  schemas:
    ClaimListResponse:
      type: object
      required:
        - claims
      properties:
        claims:
          type: array
          description: List of claims associated with the account.
          items:
            type: object
            required:
              - claimType
              - key
              - bankId
              - claimId
              - stClaim
            properties:
              claimType:
                type: string
                description: >-
                  Type of claim - PORTABILITY (transfer key from another bank)
                  or OWNERSHIP (claim abandoned key).
                enum:
                  - PORTABILITY
                  - OWNERSHIP
                example: PORTABILITY
              key:
                type: string
                description: Pix key value.
                example: '+5511987654321'
              bankId:
                type: string
                description: Bank ISPB code of the current key owner.
                example: '12345678'
              claimId:
                type: string
                description: Unique identifier for the claim.
                example: claim_abc123xyz
              stClaim:
                $ref: '#/components/schemas/ClaimStatusEnum'
    ClaimStatusEnum:
      type: string
      description: >
        Pix key ownership claim status. String values representing the state of
        a portability or ownership claim.


        **Valid values:**

        - `OPEN` = Claim has been initiated and is awaiting action from parties
        involved

        - `CONFIRMED` = Claim has been confirmed by the claimer

        - `COMPLETED` = Claim process successfully completed, key transferred

        - `CANCELLED` = Claim was cancelled by the claimer or system

        - `AWAITING_RESOLUTION` = Awaiting resolution or decision from the
        current key owner
      enum:
        - OPEN
        - CONFIRMED
        - COMPLETED
        - CANCELLED
        - AWAITING_RESOLUTION
      example: OPEN
    ErrorResponse:
      type: object
      properties:
        code:
          type: string
          description: Error code
        message:
          type: string
          description: Error message
        details:
          type: array
          items:
            type: string
          description: Additional error details
  responses:
    Unauthorized:
      description: Unauthorized - Invalid or missing authentication
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            missing_token:
              summary: Missing authentication token
              value:
                code: MISSING_TOKEN
                message: Authorization header is required
                details: []
            invalid_token:
              summary: Invalid token
              value:
                code: INVALID_TOKEN
                message: Invalid or expired access token
                details: []
            expired_token:
              summary: Expired token
              value:
                code: TOKEN_EXPIRED
                message: Access token has expired. Please obtain a new token.
                details: []
    NotFound:
      description: Not Found - Resource does not exist
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            pix_key_not_found:
              summary: Pix key not found
              value:
                code: PIX_KEY_NOT_FOUND
                message: Pix key does not exist or is not registered
                details: []
            account_not_found:
              summary: Account not found
              value:
                code: ACCOUNT_NOT_FOUND
                message: Account with specified ID does not exist
                details: []
            transaction_not_found:
              summary: Transaction not found
              value:
                code: TRANSACTION_NOT_FOUND
                message: Transaction not found
                details: []
    InternalServerError:
      description: Internal Server Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            generic_error:
              summary: Generic internal error
              value:
                code: INTERNAL_ERROR
                message: An internal error occurred. Please try again later.
                details: []
            database_error:
              summary: Database error
              value:
                code: DATABASE_ERROR
                message: Database operation failed
                details: []
            external_service_error:
              summary: External service error
              value:
                code: EXTERNAL_SERVICE_ERROR
                message: External service (JD Pix) is temporarily unavailable
                details: []
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        JWT Bearer token authentication. Obtain token from
        `/v1/login/oauth/access_token` endpoint

        using client credentials (clientId and clientSecret).


        Include token in Authorization header:

        `Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...`


        Token expires after 3600 seconds (1 hour).

````