Retrieve Loan Details Template
/lokta-lms/api/v1/loans/templateReturns the field defaults and allowed values for a loan application.
This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of:
Field Defaults
Allowed description Lists
Example Requests:
loans/template?templateType=individual&clientId=1
loans/template?templateType=individual&clientId=1&productId=1
When to use it
Call this with a clientId and productId before applying. It returns the option lists and default terms to build the application from.
Worth knowing
- Send templateType, for example templateType=individual, with the clientId and productId.
Query parameters
clientIdquery · integer · int64 · optionalclientId
productIdquery · integer · int64 · optionalproductId
templateTypequery · string · optionaltemplateType
staffInSelectedOfficeOnlyquery · boolean · optionalstaffInSelectedOfficeOnly
activeOnlyquery · boolean · optionalactiveOnly
Responses
200OKResponse fields
clientIdinteger · int64 · optionalclientNamestring · optionalclientOfficeIdinteger · int64 · optionalproductOptionsarray of GetLoansTemplateProductOptions · optionaltimelineGetLoansTemplateTimeline · optionalEvery request authenticates with HTTP Basic and carries a Tenant-Identifier header. See the conventions for dates, commands, pagination and errors.
Open this operation in the interactive explorer, or read it as Markdown.
This is the API reference for Lokta, the agentic loan servicing platform. Go to lokta.ai