Skip to main content
GET
List 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:25

Page size (default 25, max 100)

Intervalo obrigatório: 1 <= x <= 100
offset
integer<int64>
padrão:0

Page offset (default 0)

Intervalo obrigatório: x >= 0
claimerISPB
string

Optional facet: narrow the page to claims whose claimer participant matches this ISPB (8 numeric digits). It narrows WITHIN the server-derived scope and can never widen it.

donorISPB
string

Optional facet: narrow the page to claims whose donor participant matches this ISPB (8 numeric digits). It narrows WITHIN the server-derived scope and can never widen it.

Resposta

OK

items
object[]
obrigatório

Claim records for the requested limit/offset window.

limit
integer<int64>
obrigatório

Effective page size applied to this response.

offset
integer<int64>
obrigatório

Zero-based offset of the first item in this page.

requestId
string

Request-scoped identifier echoing X-Request-ID, for pivoting from response to trace. This is OUR OWN echo, distinct from any item's bacen.correlationId, which is BACEN's own value.