Affordability risk insights (beta)

Summary

Affordability insights are designed to give you timely insights into your customers' financial health, and to identify any risky spending behaviours that may be an indicator of a customers affordability position.

Affordability risk insights are broken into three groups based on their patterns;

Retrieve income/expenditure breakdown reports - Provides a view of customer expenditure relative to income for specific spending categories
Retrieve merchant-specific breakdown reports - Provides a view of spend with high risk merchant groups
Retrieve a report on a customers unauthorised overdraft - Provides a view of a customer operating their current account in unarranged overdraft

Each of these insights are accompanied by a transactions endpoint which can be used to retrieve all the relevant accounts/transactions that were used to generate the insight. It's not intended for you to hit the details endpoint each time you generate an insight for your customer but rather it can be used if you would like to show the associated accounts/transactions to an insight or for testing purposes during your integration with Bud.

Expenditure relative to income insights

Insight	Description
`income-cash-withdrawal`	Provides cash withdrawals relative to income
`income-loan`	Provides loan repayments relative to income
`income-gambling`	Provides gambling spend relative to income
`income-debt`	Provide debt collection payments relative to income
`income-essential-expenditure`	Provides essential spend relative to income
`income-all-expenditure`	Provides spend relative to income

An example of a successful 200 response can be seen below;

{
  "operation_id": "insights_beta_report_income_expenditure_get",
  "data": {
    "insights": [
      {
        "type": "income-loan",
        "currency": "GBP",
        "expenditure": {
          "credit_debit_indicator": "debit",
          "count": 10,
          "total": {
            "value": "1000.00",
            "currency": "GBP"
          },
          "monthly_average": {
            "value": "250.00",
            "currency": "GBP"
          },
          "breakdown": [
            {
              "from": "2024-01-17T00:00:00+08:00",
              "to": "2024-02-16T23:59:59+08:00",
              "total": {
                "value": "250.00",
                "currency": "GBP"
              },
              "count": 1,
              "transactions_reference": "402419e92096bd4ab499de51bffcdcacb13eeb4b6452b327a334799ffd9f4df5",
              "_links": {
                "transactions": "https://api-sandbox.thisisbud.com/financial/v2/transactions?category_l1=bills&category_l2=tv_and_broadband&date_from=2022-01-01T00%3A00%3A00Z&date_to=2022-03-31T00%3A00%3A00Z"
              }
            },
            {
              "from": "2024-02-17T00:00:00+08:00",
              "to": "2024-03-16T23:59:59+08:00",
              "total": {
                "value": "250.00",
                "currency": "GBP"
              },
              "count": 1,
              "transactions_reference": "402419e92096bd4ab499de51bffcdcacb13eeb4b6452b327a334799ffd9f4df5",
              "_links": {
                "transactions": "https://api-sandbox.thisisbud.com/financial/v2/transactions?category_l1=bills&category_l2=tv_and_broadband&date_from=2022-01-01T00%3A00%3A00Z&date_to=2022-03-31T00%3A00%3A00Z"
              }
            },
            {
              "from": "2024-04-17T00:00:00+08:00",
              "to": "2024-05-16T23:59:59+08:00",
              "total": {
                "value": "250.00",
                "currency": "GBP"
              },
              "average": {
                "value": "250.00",
                "currency": "GBP"
              },
              "count": 1,
              "transactions_reference": "402419e92096bd4ab499de51bffcdcacb13eeb4b6452b327a334799ffd9f4df5",
              "_links": {
                "transactions": "https://api-sandbox.thisisbud.com/financial/v2/transactions?category_l1=bills&category_l2=tv_and_broadband&date_from=2022-01-01T00%3A00%3A00Z&date_to=2022-03-31T00%3A00%3A00Z"
              }
            }
          ],
          "relative_to_income": "1",
          "transactions_reference": "402419e92096bd4ab499de51bffcdcacb13eeb4b6452b327a334799ffd9f4df5",
          "_links": {
            "transactions": "https://api-sandbox.thisisbud.com/financial/v2/transactions?category_l1=bills&category_l2=tv_and_broadband&date_from=2022-01-01T00%3A00%3A00Z&date_to=2022-03-31T00%3A00%3A00Z"
          }
        },
        "income": {
          "credit_debit_indicator": "credit",
          "count": 4,
          "total": {
            "value": "1000.00",
            "currency": "GBP"
          },
          "monthly_average": {
            "value": "250.00",
            "currency": "GBP"
          },
          "breakdown": [
            {
              "from": "2024-01-17T00:00:00+08:00",
              "to": "2024-02-16T23:59:59+08:00",
              "total": {
                "value": "250.00",
                "currency": "GBP"
              },
              "count": 1,
              "transactions_reference": "402419e92096bd4ab499de51bffcdcacb13eeb4b6452b327a334799ffd9f4df5",
              "_links": {
                "transactions": "https://api-sandbox.thisisbud.com/financial/v2/transactions?category_l1=bills&category_l2=tv_and_broadband&date_from=2022-01-01T00%3A00%3A00Z&date_to=2022-03-31T00%3A00%3A00Z"
              }
            },
            {
              "from": "2024-02-17T00:00:00+08:00",
              "to": "2024-03-16T23:59:59+08:00",
              "total": {
                "value": "250.00",
                "currency": "GBP"
              },
              "count": 1,
              "transactions_reference": "402419e92096bd4ab499de51bffcdcacb13eeb4b6452b327a334799ffd9f4df5",
              "_links": {
                "transactions": "https://api-sandbox.thisisbud.com/financial/v2/transactions?category_l1=bills&category_l2=tv_and_broadband&date_from=2022-01-01T00%3A00%3A00Z&date_to=2022-03-31T00%3A00%3A00Z"
              }
            },
            {
              "from": "2024-03-17T00:00:00+08:00",
              "to": "2024-04-16T23:59:59+08:00",
              "total": {
                "value": "250.00",
                "currency": "GBP"
              },
              "average": {
                "value": "250.00",
                "currency": "GBP"
              },
              "count": 1,
              "transactions_reference": "402419e92096bd4ab499de51bffcdcacb13eeb4b6452b327a334799ffd9f4df5",
              "_links": {
                "transactions": "https://api-sandbox.thisisbud.com/financial/v2/transactions?category_l1=bills&category_l2=tv_and_broadband&date_from=2022-01-01T00%3A00%3A00Z&date_to=2022-03-31T00%3A00%3A00Z"
              }
            }
          ],
          "transactions_reference": "402419e92096bd4ab499de51bffcdcacb13eeb4b6452b327a334799ffd9f4df5",
          "_links": {
            "transactions": "https://api-sandbox.thisisbud.com/financial/v2/transactions?category_l1=bills&category_l2=tv_and_broadband&date_from=2022-01-01T00%3A00%3A00Z&date_to=2022-03-31T00%3A00%3A00Z"
          }
        },
        "transactions_reference": "402419e92096bd4ab499de51bffcdcacb13eeb4b6452b327a334799ffd9f4df5",
        "_links": {
          "transactions": "https://api-sandbox.thisisbud.com/financial/v2/transactions?category_l1=bills&category_l2=tv_and_broadband&date_from=2022-01-01T00%3A00%3A00Z&date_to=2022-03-31T00%3A00%3A00Z"
        }
      }
    ]
  },
  "metadata": {
    "from": "2022-01-01T00:00:00Z",
    "to": "2022-03-31T00:00:00Z",
    "currencies": [
      "GBP"
    ],
    "options": [
      {
        "insight_type": "late_income",
        "option": "minimum_days_late_threshold",
        "value": "3"
      },
      {
        "insight_type": "late_income",
        "option": "minimum_value_threshold",
        "value": "100.00"
      }
    ]
  }
}

curl --request GET \
     --url https://api-sandbox.thisisbud.com/insights/beta/report/income-expenditure \
     --header 'accept: application/json'

High risk merchant insights

Insight	Description
`hcst-credit`	Provides number of transactions with a high-cost short-term lender

An example of a successful 200 response can be seen below;

{
  "operation_id": "insights_beta_report_merchants_get",
  "data": {
    "insights": {
      "hcst_credit": [
        {
          "type": "hcst-credit",
          "currency": "GBP",
          "transactions_count": 2,
          "merchants_count": 2,
          "transactions_reference": "402419e92096bd4ab499de51bffcdcacb13eeb4b6452b327a334799ffd9f4df5",
          "_links": {
            "transactions": "https://api-sandbox.thisisbud.com/financial/v2/transactions?category_l1=bills&category_l2=tv_and_broadband&date_from=2022-01-01T00%3A00%3A00Z&date_to=2022-03-31T00%3A00%3A00Z"
          }
        }
      ]
    }
  },
  "metadata": {
    "from": "2022-01-01T00:00:00Z",
    "to": "2022-03-31T00:00:00Z",
    "currencies": [
      "GBP"
    ],
    "options": []
  }

curl --request GET \
     --url https://api-sandbox.thisisbud.com/insights/beta/report/merchants \
     --header 'accept: application/json'

Unarranged overdraft report

Provides information about a customer operating their account in unarranged overdraft

Insight	Description
`unarranged-overdraft`	Provides number of days a customer has spent in unarranged overdraft alongside account information and credit lines

There are three possible 200 responses;

200 - Unauthorised overdraft detected
200 - No unauthorised access to overdraft detected
200 - No data ingested

An example of a successful 200 response for 'unauthorised overdraft detected' can be seen below;

{
  "operation_id": "insights_beta_report_balance_unauthorised_overdraft_get",
  "data": {
    "insights": [
      {
        "type": "unauthorised-overdraft",
        "currency": "GBP",
        "days_in_unauthorised_overdraft": {
          "count": 3,
          "ratio": "0.06"
        },
        "accounts": [
          {
            "account_id": "ee7a2d6a-2baa-461a-aca2-844e88a3f3e7",
            "provider": "test provider",
            "account_name": "current account",
            "days_in_unauthorised_overdraft": {
              "count": 3,
              "ratio": "0.06"
            },
            "unauthorised_overdraft_occurrences": [
              {
                "date": "2023-03-20T00:00:00Z",
                "amount": {
                  "value": "1200.00",
                  "currency": "GBP"
                },
                "credit_debit_indicator": "debit"
              },
              {
                "date": "2023-03-21T00:00:00Z",
                "amount": {
                  "value": "1200.00",
                  "currency": "GBP"
                },
                "credit_debit_indicator": "debit"
              },
              {
                "date": "2023-03-22T00:00:00Z",
                "amount": {
                  "value": "1200.00",
                  "currency": "GBP"
                },
                "credit_debit_indicator": "debit"
              }
            ],
            "balances": [
              {
                "date": "2023-01-12T00:00:00Z",
                "amount": {
                  "value": "100.00",
                  "currency": "GBP"
                },
                "type": "closing_available",
                "credit_debit_indicator": "debit"
              }
            ],
            "credit_lines": [
              {
                "date": "2023-01-12T00:00:00Z",
                "type": "available",
                "amount": {
                  "value": "850.00",
                  "currency": "GBP"
                }
              }
            ],
            "transactions_reference": "123419e92096bd4ab499de51bffcdcacb13eeb4b6452b327a334799ffd9f4df5",
            "_links": {
              "transactions": "https://api-sandbox.thisisbud.com/financial/v2/transactions"
            }
          }
        ]
      }
    ]
  },
  "metadata": {
    "from": "2020-01-01T00:00:00Z",
    "to": "2020-01-31T00:00:00Z",
    "currencies": [
      "GBP"
    ],
    "options": []
  }
}

curl --request GET \
     --url https://api-sandbox.thisisbud.com/insights/beta/report/balance/unauthorised-overdraft \
     --header 'accept: application/json'