Skip to main content
GET
List delinquent loans (Brazil)

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Query Parameters

carteira
enum<string>

Regulatory carteira (Res. BCB 352/2023 art. 81). Narrows to the loan product versions that declare it.

Available options:
C1,
C2,
C3,
C4,
C5
Example:

"C5"

asOf
string<date>

Business date (YYYY-MM-DD); defaults to the current business day in Brazil (UTC-3).

Example:

"2026-06-14"

productIds
string<uuid>[] | null

Filter by loan product identifiers (repeat to pass multiple).

Maximum array length: 100
Example:
productVersionIds
string<uuid>[] | null

Filter by loan product version identifiers (repeat to pass multiple).

Maximum array length: 100
Example:
bucketCode
enum<string>

Delinquency bucket code.

Available options:
current,
1_30,
31_60,
61_90,
91_plus,
par30,
par60,
par90
Example:

"par30"

assignedOfficerId
string

Narrow to one loan officer's book. Free-form authenticated identity subject, not necessarily a UUID, at most 255 characters; a system-originated contract carries the empty officer.

Maximum string length: 255
Example:

"officer-xyz"

limit
integer<int64>
default:25

Page size.

Required range: 1 <= x <= 100
Example:

25

offset
integer<int64>
default:0

Page offset.

Required range: 0 <= x <= 10000
Example:

0

Response

OK

asOfDate
string<date-time>
required

Business date the rows were computed for (RFC3339, UTC midnight).

Example:

"2026-06-14T12:00:00Z"

freshness
object
required

Provenance of the rows: snapshot identity, staleness, and freshness policy.

limit
integer<int64>
required

Page size echoed back from the request (max rows in this response).

Example:

25

loans
object[] | null
required

Delinquent loan drill-down rows for the page; always a JSON array (never null).

offset
integer<int64>
required

Zero-based row offset echoed back from the request.

Example:

0