This section outlines how to call Periculum’s Affordability API. These calls assume that you have generated analytics for a statement by calling the generate statement analytics endpoint. If you do not specify the optional parameters (averageMonthlyLoanRepaymentAmount) then the endpoint will default to using the values for these fields from the corresponding statement analytics. If you do not want to include this amount in the calculation, please set it to 0, otherwise Insights will use the generated analytics value.
| Method | Endpoint | Headers | Parameters | Body |
|---|---|---|---|---|
| POST | /affordability | Authorization value: Bearer string_encrypted_access_token | none | application/json body |