Skip to main content
GET
cURL com dados fictícios

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Cabeçalhos

X-Account-Id
string

UUID da conta associada à operação.

Exemplo:

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

Parâmetros de consulta

role
string[] | null

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

Exemplo:
status
string[] | null

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

Exemplo:
type
string[] | null

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

Exemplo:
key_type
string[] | null

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

Exemplo:
start_date
string

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

Exemplo:

"2026-05-01"

end_date
string

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

Exemplo:

"2026-05-31"

page
string

Page number (1-based, default 1)

Exemplo:

"1"

limit
string

Rows per page (default 20, max 100)

Exemplo:

"20"

sort_order
string

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

Exemplo:

"desc"

Resposta

OK

items
object[] | null
obrigatório
limit
integer<int64>
obrigatório
Exemplo:

20

page
integer<int64>
obrigatório
Exemplo:

1

total
integer<int64>
obrigatório
Exemplo:

1