Skip to main content
GET
Get portfolio dashboard

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Query Parameters

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"

Response

OK

asOfDate
string<date-time>
required

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

Example:

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

delinquencyDistribution
object[] | null
required

Loan count and exposure broken down by delinquency bucket.

drillDown
object[] | null
required

Per-loan delinquency rows for the requested bucket (empty when none).

freshness
object
required

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

summary
object
required

Portfolio-level exposure, volume, and PAR roll-up for the business date.

trend
object[] | null
required

Month-by-month historical series leading up to the business date.