Skip to main content
GET
cURL with fictitious data

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Headers

X-Account-Id
string

UUID of the account associated with the operation.

Example:

"019606a1-3b4c-7d8e-9f01-234567890abc"

Query Parameters

role
string[] | null

Filter by the account's role in the claim (repeatable, case-insensitive): CLAIMER, DONOR

Example:
status
string[] | null

Filter by claim status (repeatable, case-insensitive): OPEN, WAITING_RESOLUTION, CONFIRMED, COMPLETED, CANCELLED

Example:
type
string[] | null

Filter by claim type (repeatable, case-insensitive): PORTABILITY, OWNERSHIP

Example:
key_type
string[] | null

Filter by key type (repeatable, case-insensitive): CPF, CNPJ, EMAIL, PHONE, EVP

Example:
start_date
string

Filter claims created on or after this date (YYYY-MM-DD)

Example:

"2026-05-01"

end_date
string

Filter claims created on or before this date (YYYY-MM-DD)

Example:

"2026-05-31"

page
string

Page number (1-based, default 1)

Example:

"1"

limit
string

Rows per page (default 20, max 100)

Example:

"20"

sort_order
string

Sort direction by createdAt (default desc, case-insensitive)

Example:

"desc"

Response

OK

items
object[] | null
required
limit
integer<int64>
required
Example:

20

page
integer<int64>
required
Example:

1

total
integer<int64>
required
Example:

1