Sign in

v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB
Loan Accounts

Get active loan account

Returns the active loan account detail read model. A malformed UUID yields 422 (schema error), distinct from 404 when the account does not exist.

get/api/v1/loan-accounts/{id}

Path parameters

idstring uuid required

Loan account identifier (UUID).

Example:550e8400-e29b-41d4-a716-446655440000

Loan account identifier (UUID).

Response

OK

assignedOfficerIdstring required

Identifier of the loan officer assigned to service this account.

borrowerIdstring required

Identifier of the borrower who holds this account.

disbursementDatestring

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

jurisdictionCodestring required

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

loanAccountIdstring required

Loan account UUID.

loanApplicationIdstring required

Originating loan application UUID.

openBalancestring required

Total open balance including fees and penalties (2 d.p. string).

principalBalancestring required

Outstanding principal balance (2 d.p. string).

profileVersionstring required

Product profile version applied to this account.

statusstring required

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

Example response

{
  "assignedOfficerId": "550e8400-e29b-41d4-a716-446655440003",
  "borrowerId": "550e8400-e29b-41d4-a716-446655440002",
  "disbursementDate": "2026-06-14",
  "jurisdictionCode": "BR",
  "loanAccountId": "550e8400-e29b-41d4-a716-446655440000",
  "loanApplicationId": "550e8400-e29b-41d4-a716-446655440001",
  "openBalance": "1450.00",
  "principalBalance": "1234.56",
  "profileVersion": "1.0.0",
  "status": "active"
}