Pular para o conteúdo principal
GET
List Key Claims

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de consulta

limit
integer<int64>
padrão:10

Maximum number of claims per page (1-100)

page
integer<int64>
padrão: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
padrão:asc

Sort direction: asc or desc

bacen_claim_id
string<uuid>

Filter by BACEN claim ID (UUID)

Resposta

OK

items
object[]
obrigatório

Array of claims

limit
integer<int64>
obrigatório

Number of items per page

Exemplo:

10

page
integer<int64>
obrigatório

Current page number

Exemplo:

1

total
integer<int64>
obrigatório

Total number of claims matching the filters

Exemplo:

42