Data modelsBanking

Loans & mortgages

What the customer owes to this institution, and what it costs them every month
View as Markdown

Where it lives: at loans in the Financial Position, and on its own from the loans endpoint. One endpoint returns both kinds; sub_family tells them apart.

This is the debt half of an affordability assessment: how much was granted, how much is still outstanding, what the instalment is and when it falls. Together with the credit registry — which reports debt at other institutions — it closes the picture.

Personal loans

idstringRequiredformat: "object-id"

Product ID for the current execution. Note: it may change between executions.

product"financial_loan"Required
sub_family"financial_loan:personal"Required
fetch_datestringRequiredformat: "datetime"
Date this product was fetched
identifierobjectRequired
Loan identifier
customer_segmentenumRequired
product_namestringRequired
Product name
linked_accountobjectOptional
Linked account
product_aliasstringOptional
Product alias
product_descriptionstringOptional
Product Description
initial_balanceobjectOptional
Initial balance of the loan
outstanding_balanceobjectOptional
Outstanding balance of the loan
next_payment_amountobjectOptional
Next payment amount
begin_datedateOptional
Loan start date
renovation_datedateOptional
Renovation Date
end_datedateOptional
Loan expected end date
next_payment_datedateOptional
Next payment date
interest_rateobjectOptional
Loan interest rate
current_periodintegerOptional
Current period
pending_periodsintegerOptional
Pending periods
total_periodsintegerOptional
Total periods

Mortgages

The same shape, plus the fields a long-term loan needs: which period it is in and how many are left.

idstringRequiredformat: "object-id"

Product ID for the current execution. Note: it may change between executions.

product"financial_loan"Required
sub_family"financial_loan:mortgage"Required
fetch_datestringRequiredformat: "datetime"
Date this product was fetched
identifierobjectRequired
Loan identifier
customer_segmentenumRequired
product_namestringRequired
Product name
linked_accountobjectOptional
Linked account
product_aliasstringOptional
Product alias
product_descriptionstringOptional
Product Description
initial_balanceobjectOptional
Initial balance of the loan
outstanding_balanceobjectOptional
Outstanding balance of the loan
next_payment_amountobjectOptional
Next payment amount
begin_datedateOptional
Loan start date
renovation_datedateOptional
Renovation Date
end_datedateOptional
Loan expected end date
next_payment_datedateOptional
Next payment date
interest_rateobjectOptional
Loan interest rate
current_periodintegerOptional
Current period
pending_periodsintegerOptional
Pending periods
total_periodsintegerOptional
Total periods
loan_idstringRequired
Identifier of the loan
lender_idstringRequired

Identifier of the lender (NIF/CIF)

lender_namestringRequired
Name of the lender
amortized_capitalmap from strings to stringsRequired
Total amortized capital
interestsmap from strings to stringsRequired
Total interests paid
financial_expensesmap from strings to stringsRequired
Total financial expenses
taxpayer_idstringRequired
National identifier of the taxpayer for this line
participationstringOptionalformat: "number"Defaults to nan
Percentage of participation in the loan
formalization_datedateOptional
Date the loan was formalized

next_payment_amount and next_payment_date are the affordability numbers. outstanding_balance says how much is left in total; the instalment says what it takes out of this month’s income — which is the one a debt-to-income ratio is built from.