Skip to main content
GET
List Key Claims

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Query Parameters

limit
integer<int64>
default:10

Maximum number of claims per page (1-100)

page
integer<int64>
default:1

Page number for pagination

type
string

Filter by claim type: OWNERSHIP, PORTABILITY

status
string[]

Filter by status (comma-separated, OR-matched): OPEN, WAITING_RESOLUTION, CONFIRMED, CANCELLED, COMPLETED

key_value
string

Filter by Pix key value

sort_order
string
default:asc

Sort direction: asc or desc

bacen_claim_id
string<uuid>

Filter by BACEN claim ID (UUID)

Response

OK

items
object[]
required

Array of claims

limit
integer<int64>
required

Number of items per page

Example:

10

page
integer<int64>
required

Current page number

Example:

1

total
integer<int64>
required

Total number of claims matching the filters

Example:

42