Saltar al contenido principal
GET
Get active loan account

Autorizaciones

Authorization
string
header
requerido

JWT bearer token issued by the identity provider.

Parámetros de ruta

id
string<uuid>
requerido

Loan account identifier (UUID).

Ejemplo:

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

Respuesta

OK

assignedOfficerId
string
requerido

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.

Ejemplo:

"officer-xyz"

borrowerId
string<uuid>
requerido

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

Ejemplo:

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

jurisdictionCode
string
requerido

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

Ejemplo:

"BR"

lifecycleState
enum<string>
requerido

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.

Opciones disponibles:
active,
settled,
ceded,
ported,
reversed,
renegotiated
Ejemplo:

"active"

loanAccountId
string
requerido

Loan account UUID.

Ejemplo:

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

loanApplicationId
string
requerido

Originating loan application UUID.

Ejemplo:

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

openBalance
string
requerido

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.

Ejemplo:

"1450.00"

paymentHealth
object
requerido

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
requerido

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.

Ejemplo:

"1234.56"

profileVersion
string
requerido

Product profile version applied to this account.

Ejemplo:

"1.0.0"

status
string
requerido

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

Ejemplo:

"active"

disbursementDate
string

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

Ejemplo:

"2026-06-14"