How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Bud Financial Retrieve Affordability Risk Insights API

Retrieve a customer's report insights generated from their financial data. In contrast to the alert style actionable insights,these insights should be used more as a summary.

Bud Financial Retrieve Affordability Risk Insights API is one of 32 APIs that Bud Financial publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 2 JSON Schema definitions.

Tagged areas include Retrieve Affordability Risk Insights. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 2 JSON Schemas.

This API exposes 8 operations across 8 paths, and defines 35 schemas. It is described by OpenAPI 3.2.0, at version 2.10.10.

Requests are made against a single base URL, https://api-sandbox.thisisbud.com.

8 operations 8 paths 35 schemas 8 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.10.10
Base URL
https://api-sandbox.thisisbud.com
Authentication
HTTP Basic, OAuth 2.0
Resource Areas
1

Authentication & Security 2

Bud Financial Retrieve Affordability Risk Insights API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (Basic). It supports OAuth 2.0 (OAuth2) using the clientCredentials flow.

  • OAuth2 — Authentication flow: 1. Perform OAuth2 Client Credentials authentication using API Credentials (clientid,clientsecret) to obtain an accesstoken against /v1/oau…

Paths & Operations 8

Across 8 paths, the API surfaces 8 operations — 8 GET. Each is listed below with its method, path, parameters, and response codes.

Retrieve Affordability Risk Insights 8

Retrieve a customer's report insights generated from their financial data. In contrast to the alert style actionable insights, these insights should be used more as a summary.

GET
/insights/beta/report/income-expenditure
Retrieve income/expenditure break down reports
insights_beta_report_income_expenditure_get 8 params → 200
GET
/insights/beta/report/income-expenditure/transactions/{reference}
Retrieve transactions relating to a specific insight report section.
insights_beta_report_income_expenditure_transactions_get 8 params → 200
GET
/insights/beta/report/merchants
Retrieve merchant-specific breakdown reports.
insights_beta_report_merchants_get 8 params → 200
GET
/insights/beta/report/merchants/transactions/{reference}
Retrieve transactions relating to a specific insight report section.
insights_beta_report_merchants_transactions_get 8 params → 200
GET
/insights/beta/report/balance/unauthorised-overdraft
Retrieve a report on a customers unauthorised overdraft.
insights_beta_report_balance_unauthorised_overdraft_get 8 params → 200
GET
/insights/beta/report/balance/unauthorised-overdraft/transactions/{reference}
Retrieve transactions relating to a specific insight report section.
insights_beta_report_unauthorised_overdraft_transactions_get 8 params → 200
GET
/insights/beta/report/income-health
Retrieve a health report on a customers financial profile.
insights_beta_report_income_health_get 8 params → 200
GET
/insights/beta/report/income-health/transactions/{reference}
Retrieve transactions relating to a specific insight report section.
insights_beta_report_income_health_transactions_get 8 params → 200

Schemas 35

The contract defines 35 schemas that model the data the API accepts and returns. The most detailed are InsightsTransaction (15 properties), RegularTransactionIncomeGroup (10 properties), UnauthorisedOverdraftAccount (9 properties), Enrichments (7 properties). Each schema is shown below with its type and property counts.

TransactionsReference
string
A unique identifier to reference a specific transaction subset used within a section of a report.
Token
object
The token item.
2 properties 2 required
UnauthorisedOverdraftDate
object
3 properties 3 required
schemas-TransactionsLinks
object
URLs for resources related to this report insight
1 property 1 required
UnauthorisedOverdraftAccount
object
9 properties 9 required
HCSTCreditAnalysis
object
Object represents analysis indicating interactions with high-cost short-term credit providers.
6 properties 6 required
Location
object
Location enrichment associated with a Transaction
3 properties
IrregularTransactions
object
4 properties 4 required
ReportInsightsTransactionResponse
object
3 properties 3 required
IncomeExpenditureAnalysis
object
Object presents a single expenditure group income analysis report. The focus of this object is to present a view of a single expenditure and its impact on a cu…
6 properties 5 required
BudMonetaryValue
string
The value of the monetary amount. The value is formatted with the number of decimal places for the respective currency. Example: 10.98
UnauthorisedOverdraftResponse
object
3 properties 3 required
Enrichments
object
Contextual enrichments associated with a Transaction
7 properties
schemas-DateTimeISO8601
string
ISO Date Format
Processor
object
Processor enrichment associated with a Transaction, as generated using a combination of Bud's artificial intelligence models and database of known payment proc…
6 properties
CreditLine
object
3 properties 3 required
IncomeExpenditureReportResponse
object
3 properties 3 required
BudCurrency
string
The three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) of the monetary amount. Example: GBP
RegularTransactionIncomeGroup
object
10 properties 10 required
IncomeStability
object
2 properties 2 required
Frequency
string
Categories
object
Categories enrichment associated with a Transaction, as generated by Bud's artificial intelligence models. Currently two levels of category are supported, with…
2 properties
balance
object
4 properties 4 required
Regularity
object
Regularity enrichment associated with a Transaction, as generated by Bud's artificial intelligence models. Transactions that are similar and have a known frequ…
3 properties
InsightOption
object
An option used to configure the returned insights.
3 properties 3 required
Category
object
Category associated with a Transaction
2 properties 2 required
IncomeHealthReportResponse
object
3 properties 3 required
MerchantsReportResponse
object
Object represents a set of merchant-related insights generated for the customer inspecting transactions over a given period of time. The insights include: - hc…
3 properties 3 required
UnauthorisedOverdraftInsight
object
4 properties 4 required
InsightsTransaction
object
A financial transaction
15 properties 8 required
RegularTransactions
object
6 properties 6 required
DaysInUnauthorisedOverdraft
object
Object represents the number of days a customer has been in an unauthorised overdraft. Should be noted that this is a percentage of the total number of days in…
2 properties 2 required
CreditDebitIndicator
string
BudAmount
object
The monetary amount.
2 properties 2 required
Merchant
object
Merchant enrichment associated with a Transaction, as generated using a combination of Bud's artificial intelligence models and database of known merchants.
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bud-co-retrieve-affordability-risk-insights-api-openapi.yml Raw ↑

Other APIs Bud Financial publishes across the network.

Bud Financial Aggregation Buckets API
Bud Financial Correct Financial Data API
Bud Financial Create a Connection API
Bud Financial Custom Insights API
Bud Financial Customer Application Links API
Bud Financial Customer Applications API
Bud Financial Debt Collection Finder API
Bud Financial Enrichment Resources API
Bud Financial Enrichment Totals API
Bud Financial Frontend Widgets API
Bud Financial Income Finder API
Bud Financial Ingest First Party Data API
Where this information came from

This is an independent, third-party profile of Bud Financial Retrieve Affordability Risk Insights API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.