Skip to main content
GET
/
v1
/
dict
/
claims
List Claims
curl --request GET \
  --url https://plugin-pix-indirect.api.lerian.net/v1/dict/claims \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "bacenClaimId": "cc91b1b0-8465-44b1-a760-15dd3717ea9b",
      "key": "+5561988887777",
      "keyType": "PHONE",
      "type": "OWNERSHIP",
      "status": "OPEN",
      "donorParticipant": "30306294",
      "resolutionPeriodEnd": "2024-01-22T10:30:00Z",
      "completionPeriodEnd": "2024-01-29T10:30:00Z",
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-01-15T10:30:00Z"
    }
  ],
  "page": 1,
  "limit": 10
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
limit
integer
default:10

Maximum number of items per page.

Required range: 1 <= x <= 100
​
page
integer
default:1

Page number for pagination.

Required range: x >= 1
​
type
enum<string>

Filter by claim type.

Available options:
OWNERSHIP,
PORTABILITY
​
status
enum<string>

Filter by claim status.

Available options:
OPEN,
WAITING_RESOLUTION,
CONFIRMED,
CANCELLED,
COMPLETED
​
key_value
string

Filter by Pix key value.

​
sort_order
enum<string>
default:asc

Sort direction: asc or desc.

Available options:
asc,
desc
​
bacen_claim_id
string

Filter by BACEN claim ID (UUID).

Response

List of claims retrieved successfully.

​
items
object[]
required
​
page
integer
required
Example:

1

​
limit
integer
required
Example:

10