Skip to navigation

Loans & mortgages

View as Markdown

Loans, mortgages and financing granted by the institution.

Each one carries the amount granted and the amount outstanding, the instalment, the rate, the dates, the account it is charged to and the repayment record the institution publishes. Field by field in Loans & mortgages.

Half of an affordability assessment lives here, and the other half in the credit registry: this endpoint shows what this institution lent, the registry shows what everybody else did.

Requires the loans_read feature

Features are chosen when the execution starts, not here. An execution that did not ask for loans_read answers 204, and the only way to get the data is to run another one.

StatusMeaning
200The loans and mortgages.
202feature_not_ready — loans_read is still running. Only this family waits: the ones that already closed answer now.
204The execution never asked for loans_read. No body.
404No execution with that id for your application, or it has been deleted.

Server to server only. This call is authorised with your application secret: it belongs in your backend, never in a browser, a mobile app or anything your customer can read.

Authentication

X-APP-SECRETstring
Application Secret

Path parameters

execution_idstringRequiredformat: "object-id"
The execution, as the acceptance response returned it.

Response

200 OK
Personal loans and mortgages, with the principal, what is still owed, the instalment and the schedule the institution reports.

An empty list is an answer, not a gap: the feature ran and the source reported none.

Personal Loanobject
OR
Mortgageobject

Errors

404
Not Found Error
422
Unprocessable Entity Error