Once you've requested affordability insights and the status of your request is complete, you can retrieve the results. There are two parts to this process:

Retrieve the Overview

This overview provides the cashflow summary and indicators. The cashflow summary shows typical monthly income, essential expenditure, and non-essential expenditure, broken down by category. Indicators highlight transactions that meet specific criteria such as transactions pertaining to gambling, childcare and insurance.

Use the GET Affordability Insights endpoint and ensure the relevant request_id is specified in the URL.

{
  "request_id": "a5f84a41-01cf-4d21-901d-124c5a7c743a",
  "status": "Complete",
  "entity_id": "7885857d-fa2b-43ab-8b15-67e5fea8e896",
  "entity_type": "case",
  "datetime_requested": "2023-11-29T12:21:52.933Z",
  "datetime_completed": "2023-11-29T12:22:07.747Z",
  "data": {
    "cashflow": [
      {
        "group": "Income",
        "value": 5249.19,
        "categories": [
          {
            "name": "Regular wage and salary",
            "value": 5109.45
          },
          {
            "name": "Benefits",
            "value": 139.74
          }
        ]
      },
      {
        "group": "Essential expenditure",
        "value": -3360.77,
        "categories": [
          {
            "name": "Utilities",
            "value": -1279.63
          },
          {
            "name": "Groceries and shopping",
            "value": -2081.14
          }
        ]
      }
    ],
    "indicators": [
      {
        "name": "Benefits",
        "present": true
      }
    ]
  }
}

Retrieve the Detailed Transaction View

The detailed transaction view provides a comprehensive breakdown of categorised transactions, providing granular view of monthly, aggregate and average spend by merchant, grouped by category.

Use the GET Affordability Insights endpoint and ensure the relevant request_id is specified in the URL.

{
  "request_id": "a5f84a41-01cf-4d21-901d-124c5a7c743a",
  "status": "Complete",
  "entity_id": "7885857d-fa2b-43ab-8b15-67e5fea8e896",
  "entity_type": "case",
  "datetime_requested": "2023-11-29T12:21:52.933Z",
  "datetime_completed": "2023-11-29T12:22:07.747Z",
  "data": [
    {
      "group": "Essential expenditure",
      "category": "Utilities",
      "short_description": "EE Limited",
      "number_of_transactions": 6,
      "total_value": -271.44,
      "average_value": -45.24,
      "minimum_value": -50.34,
      "maximum_value": -40.14,
      "monthly_data": [
        {
          "year": 2023,
          "month": 10,
          "total_value": -90.48
        },
        {
          "year": 2023,
          "month": 9,
          "total_value": -90.48
        },
        {
          "year": 2023,
          "month": 8,
          "total_value": -40.14
        },
        {
          "year": 2023,
          "month": 11,
          "total_value": -50.34
        }
      ]
    },
    {
      "group": "Essential expenditure",
      "category": "Groceries and shopping",
      "short_description": "Tesco Store Hook",
      "number_of_transactions": 40,
      "total_value": -1209.16,
      "average_value": -30.23,
      "minimum_value": -56.24,
      "maximum_value": -3.66,
      "monthly_data": [
        {
          "year": 2023,
          "month": 10,
          "total_value": -419.2
        },
        {
          "year": 2023,
          "month": 11,
          "total_value": -97.38
        },
        {
          "year": 2023,
          "month": 9,
          "total_value": -451.62
        },
        {
          "year": 2023,
          "month": 8,
          "total_value": -240.96
        }
      ]
    }
  ]
}