Skip to main content
GET
Get active loan account

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Path Parameters

id
string<uuid>
required

Loan account identifier (UUID).

Example:

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

Response

OK

assignedOfficerId
string
required

Identifier of the loan officer assigned to service this account, or empty on a system-originated contract, which has no human officer. Whatever the identity provider issues as the subject: not necessarily a UUID.

Example:

"officer-xyz"

borrowerId
string<uuid>
required

Identifier (UUID) of the borrower who holds this account.

Example:

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

jurisdictionCode
string
required

ISO 3166-1 jurisdiction code the account operates under (e.g. BR).

Example:

"BR"

lifecycleState
enum<string>
required

Where the contract stands, as a durable recorded fact. active: no terminal fact closes the account — including one that was closed and later reopened by a repurchase or by undoing a refinance. settled: the borrower discharged the debt. ceded: the receivable was sold and left this balance sheet. ported: the contract moved to another institution. reversed: a refinance the rail undid inside its regret window. renegotiated: a substantial renegotiation replaced this contract and the debt is carried on the new account it opened. Only settled means the borrower discharged the debt — do not label any of the other four as one, and do not read any of them as a statement about whether payments were made on time, which is paymentHealth. Always present.

Available options:
active,
settled,
ceded,
ported,
reversed,
renegotiated
Example:

"active"

loanAccountId
string
required

Loan account UUID.

Example:

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

loanApplicationId
string
required

Originating loan application UUID.

Example:

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

openBalance
string
required

Total balance THIS institution carries on the contract, including fees and penalties (2 d.p. string). Governed by the same rule as principalBalance and paymentHealth: zero once the credit risk has left this book.

Example:

"1450.00"

paymentHealth
object
required

How the borrower is paying, derived when this response is built and stored nowhere. Assessed ONLY while lifecycleState is active: a live contract can be months overdue, and on a closed one state is 'unknown' rather than 'current', because the schedule copy a closed contract leaves behind is not a debt this book still carries.

principalBalance
string
required

Outstanding principal THIS institution carries on the contract (2 d.p. string). Zero once the credit risk has left this book — see paymentHealth for the rule — and zero is the number there rather than a placeholder: what this book carries on a receivable it sold is nothing. The contract's own history is unaffected; the schedule, transactions and charges still answer it.

Example:

"1234.56"

profileVersion
string
required

Product profile version applied to this account.

Example:

"1.0.0"

status
string
required

Account lifecycle status (e.g. active, closed, in_arrears).

Example:

"active"

disbursementDate
string

ISO-8601 date of fund disbursement; omitted until disbursed.

Example:

"2026-06-14"