Request

curl --location --request POST 'https://api.insights-periculum.io/affordability' 
--header 'Authorization: Bearer string_encrypted_accesst_token' 
--header 'Content-Type: application/json' 
--data-raw '{
    "dti": 0.3,
    "statementKey": 3,
    "loanTenure": 6,
    "averageMonthlyLoanRepaymentAmount": 1000
}'

Request Parameters

NameDescriptionTypeRequired
statementKeyThe key of the statement to generate the affordability analysis for. You can only generate affordability for 'PROCESSED' statementsintYes
dtiDebt to income ratio for the affordability analysisdouble (between 0-1)Yes
loanTenureThe period of the loan in monthsintYes
averageMonthlyLoanRepaymentAmountAverage Monthly Loan Repayment Amount ( Note: This field can be ignored by setting the value to 0, so it will not be added in the calculation)doubleNo