API: Affordability report

Summary

Affordability Report

Given the obvious importance of the customer's affordability in assessing their loan application, Assess produced the GET v1/affordability/report endpoint (here) which returns the most important information.

This endpoint returns information concerning a customer's affordability, for example: their Net Discretionary Income, monthly expenditure (essential and non-essential) as well as predictions for income and other categories. If you use one endpoint to automate decisioning with Assess, it's generally this one. You can see an example response below:

{
  "operation_id": "v1_affordability_report",
  "data": {
    "months_assessed": {
      "start": "2022-01",
      "end": "2022-03"
    },
    "accounts": {
      "connected": 3,
      "holder_names": [
        "John Doe"
      ],
      "missing_data": {
        "income": false,
        "expenditure": false
      }
    },
    "assessment": {
      "income": {
        "net_disposable": {
          "predicted_monthly": {
            "value": "1500.00",
            "currency": "GBP"
          },
          "_links": {
            "transactions": "/v1/affordability/transactions?criteria=net_disposable_income"
          }
        },
        "net_discretionary": {
          "predicted_monthly": {
            "value": "70.00",
            "currency": "GBP"
          },
          "_links": {
            "income_transactions": "/v1/affordability/transactions?criteria=net_disposable_income",
            "expenditure_transactions": "/v1/affordability/transactions?criteria=essential_expenditure"
          }
        }
      },
      "expenditure": {
        "fixed": {
          "predicted_monthly": {
            "value": "1000.00",
            "currency": "GBP"
          },
          "_links": {
            "transactions": "/v1/affordability/transactions?criteria=fixed_expenditure"
          }
        },
        "flexible": {
          "predicted_monthly_range": {
            "low": {
              "value": "10.00",
              "currency": "GBP"
            },
            "high": {
              "value": "100.00",
              "currency": "GBP"
            },
            "average": {
              "value": "56.00",
              "currency": "GBP"
            }
          },
          "_links": {
            "transactions": "/v1/affordability/transactions?criteria=flexible_expenditure"
          }
        },
        "essential": {
          "predicted_monthly": {
            "value": "500.00",
            "currency": "GBP"
          },
          "_links": {
            "transactions": "/v1/affordability/transactions?criteria=essential_expenditure"
          }
        },
        "non_essential": {
          "predicted_monthly": {
            "value": "80.00",
            "currency": "GBP"
          },
          "_links": {
            "transactions": "/v1/affordability/transactions?criteria=non_essential_expenditure"
          }
        }
      }
    }
  }
}

If you have any questions, please contact us via the chatbot (bottom-right of screen 👉) or via a support request or check our FAQs.