List portability claims

​

Lists claims associated with the given account branch and account number, with optional filters.

Query Parameters
  • branch
    Type: string
    min length:  
    1
    required

    Account branch number

  • accountNumber
    Type: string
    min length:  
    1
    required

    Account number

  • status
    Type: string enum

    Filter by claim status

    values
    • OPEN
    • WAITING_RESOLUTION
    • CONFIRMED
    • CANCELLED
    • COMPLETED
  • type
    Type: string enum

    Filter by claim type

    values
    • PORTABILITY
    • OWNERSHIP
  • keyType
    Type: string enum

    Filter by Pix key type

    values
    • EVP
    • CPF
    • CNPJ
    • PHONE
    • EMAIL
  • isDonor
    Type: boolean

    Filter by isDonor flag — true: account is the donor; false: account is not the donor

  • isClaimer
    Type: boolean

    Filter by isClaimer flag — true: account is the claimer; false: account is not the claimer

  • createdAfter
    Type: string Format: date

    Filter claims created on or after this date (ISO 8601 date)

  • modifiedAfter
    Type: string Format: date

    Filter claims last modified on or after this date (ISO 8601 date)

  • modifiedBefore
    Type: string Format: date

    Filter claims last modified before this date (ISO 8601 date)

  • page
    Type: integer Format: int32

    Page number to retrieve (zero-based, minimum: 0)

  • size
    Type: integer Format: int32

    Number of records per page (minimum: 1, maximum: 500)

  • sort
    Type: array string[]

    Sort criteria list

Headers
  • Idempotency-Key
    Type: string
    required

    Unique idempotency key for the request (UUID format)

Responses
  • application/json
  • application/json
  • application/json
Request Example for get/api/v1/claims
curl 'http://localhost:8080/api/v1/claims?branch=&accountNumber=' \
  --header 'Idempotency-Key: ' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "dictClaimId": "123e4567-e89b-12d3-a456-426614174000",
      "type": "PORTABILITY",
      "key": "string",
      "keyType": "EVP",
      "status": "OPEN",
      "claimerParticipant": "string",
      "donorParticipant": "string",
      "claimer": {
        "personType": "string",
        "taxId": "string",
        "name": "string",
        "tradeName": "string"
      },
      "claimerAccount": {
        "participant": "string",
        "branch": "string",
        "accountNumber": "string",
        "accountType": "string",
        "openingDate": "string"
      },
      "resolutionPeriodEnd": "2026-07-29T19:28:46.545Z",
      "completionPeriodEnd": "2026-07-29T19:28:46.545Z",
      "closingPeriodEnd": "2026-07-29T19:28:46.545Z",
      "expiresAt": "2026-07-29T19:28:46.545Z",
      "isDonor": true,
      "isClaimer": true,
      "cancelReason": "USER_REQUESTED",
      "cancelledBy": "DONOR",
      "confirmedBy": "DONOR",
      "completedBy": "CLAIMER",
      "lastModified": "2026-07-29T19:28:46.545Z",
      "requestedAt": "2026-07-29T19:28:46.545Z",
      "acknowledgedAt": "2026-07-29T19:28:46.545Z",
      "confirmedAt": "2026-07-29T19:28:46.545Z",
      "cancelledAt": "2026-07-29T19:28:46.545Z",
      "completedAt": "2026-07-29T19:28:46.545Z"
    }
  ],
  "totalItems": 1,
  "page": 1,
  "size": 1,
  "totalPages": 1,
  "hasNext": true
}

Claims retrieved successfully.