Get aggregated loan overview for a client

get

https://embarc-api-qa.lendapi.com/embarc-core/api/v1/clients/{clientId}/loans/overview

Ops-facing loan overview, unchanged by default. With includeCollateral=true, each loan also carries a collateralPayload rollup, so a client rendering a loan list does not need a follow-up call per loan to GET /v1/loans/{loanId}/collateral. collateralItemLimit=N (max 20) additionally returns each loan's N highest-valued ACTIVE items. See api_contracts.md, "Client Loan Overview".

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

clientId

integer

required

The client whose loans are listed.

Query Params

status

string

ACTIVE or CLOSED, case-insensitive. Any other value (or omitted) returns all statuses. CLOSED fans out over obligations-met, written-off, and rescheduled-outstanding.

includeCollateral

boolean

Defaults to false

Defaults to false. When true, adds collateralPayload to every loan item and requires READ_COLLATERAL. Opt-in so an existing caller holding READ_LOAN but not READ_COLLATERAL is not newly rejected.

collateralItemLimit

integer

Defaults to 0

Defaults to 0 (rollup only). When positive, each loan's collateralPayload also carries its N highest-valued ACTIVE items. Capped at 20; a larger value silently gets the maximum rather than a 400. Ignored unless includeCollateral=true.

includeAutopay

boolean

Defaults to true

Whether to include each loan's autopay enrollment. Unchanged.

fields

string

basic omits loanPayload. Unchanged.

offset

integer

Standard pagination offset. Unchanged.

limit

integer

Standard pagination limit. Unchanged.

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

404clientId does not resolve to a known client.