Skip to main content
GET
List loan accounts

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Query Parameters

status
enum<string>

Narrow to one originating application status. Only these two statuses ever carry a loan account.

Available options:
disbursed,
active
Example:

"active"

borrowerId
string<uuid>

Narrow to one borrower's book. The borrower identifier is a UUID — the same identity origination stored on the contract.

Example:

"550e8400-e29b-41d4-a716-446655440002"

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"

loanProductVersionId
string<uuid>

Narrow to the contracts booked under one loan product version.

Example:

"550e8400-e29b-41d4-a716-446655440001"

currency
string

Narrow to one ISO-4217 denomination.

Pattern: ^[A-Z]{3}$
Example:

"BRL"

includeClosed
boolean
default:false

Include accounts a terminal lifecycle fact closed — settled, ceded, ported, reversed or renegotiated. Default false: the live book only. Included rows carry lifecycleStatus saying which of the five closed them.

limit
integer<int64>
default:25

Page size.

Required range: 1 <= x <= 100
offset
integer<int64>
default:0

Page offset.

Required range: 0 <= x <= 10000

Response

OK

data
object[] | null
required

Page of loan accounts, newest first; always present, empty slice when none match.