Retrieve Income Actionable Insight Details

get

https://api-sandbox.thisisbud.com/insights/v1/actionable/income/{type}/{id}/details

Retrieve insight-specific details and transaction and account data responsible for the triggered income insight of the given type and ID.

Note:

For more information about Actionable Insights, please refer to our guide.

Path Params

type

string

enum

required

A type of income insight available on the platform.

Allowed:

string

required

The insight ID to provide data for,

Query Params

from

string

A start time to check financial data for insights from. Configures the earliest financial data which may be used to generate insights. If omitted, defaults to the start of the sixth complete month prior to the latest ingested financial data. Note that some insights will only be checked for complete months entirely between the from and to dates.

string

An end time to check financial data for insights up to. Configures the latest financial data which may be used to generate insights. If omitted, defaults to the date of the latest ingested financial data. Note that some insights will only be checked for complete months entirely between the from and to dates. Insights relating to potential future events, such as cannot_cover_bills, may forecast them up to a month after this point.

gambling_income.minimum_monthly_threshold

number

A minimum absolute total of gambling income for the insight to trigger. Both gambling_income.minimum_monthly_threshold and gambling_income.minimum_percentage_total_threshold must be met to trigger. If not specified, a configured value will be used. Please note that including this request on a customer level will increase latency of this endpoint. Instead, we recommend to update the thresholds for your organisation by raising a support request.

gambling_income.minimum_percentage_total_threshold

number

A minimum percentage of all income that must be gambling income for the insight to trigger. Both gambling_income.minimum_monthly_threshold and gambling_income.minimum_percentage_total_threshold must be met to trigger. If not specified, a configured value will be used. Please note that including this request on a customer level will increase latency of this endpoint. Instead, we recommend to update the thresholds for your organisation by raising a support request.

late_income.minimum_value_threshold

number

A minimum value of a late transaction in that transaction's currency for the insight to trigger. Both late_income.minimum_value_threshold and late_income.minimum_days_late_threshold must be met to trigger. If not specified, a configured value will be used. Please note that including this request on a customer level will increase latency of this endpoint. Instead, we recommend to update the thresholds for your organisation by raising a support request.

late_income.minimum_days_late_threshold

number

A minimum number of days late for a transaction to be for the insight to trigger. Both late_income.minimum_value_threshold and late_income.minimum_days_late_threshold must be met to trigger. If not specified, a configured value will be used. Please note that including this request on a customer level will increase latency of this endpoint. Instead, we recommend to update the thresholds for your organisation by raising a support request.

pension_income.minimum_monthly_threshold

number

A minimum absolute total of pension income for the insight to trigger. Both pension_income.minimum_monthly_threshold and pension_income.minimum_percentage_total_threshold must be met to trigger. If not specified, a configured value will be used. Please note that including this request on a customer level will increase latency of this endpoint. Instead, we recommend to update the thresholds for your organisation by raising a support request.

pension_income.minimum_percentage_total_threshold

number

A minimum percentage of all income that must be pension income for the insight to trigger.. Both pension_income.minimum_monthly_threshold and pension_income.minimum_percentage_total_threshold must be met to trigger. If not specified, a configured value will be used. Please note that including this request on a customer level will increase latency of this endpoint. Instead, we recommend to update the thresholds for your organisation by raising a support request.

regular_income_changed.minimum_absolute_change_threshold

number

A minimum absolute change between the previous and latest amounts of a regular payment for the insight to trigger. Both regular_income_changed.minimum_absolute_change_threshold and regular_income_changed.minimum_percentage_change_threshold must be met to trigger. If not specified, a configured value will be used. Please note that including this request on a customer level will increase latency of this endpoint. Instead, we recommend to update the thresholds for your organisation by raising a support request.

regular_income_changed.minimum_percentage_change_threshold

number

A minimum percentage change between the previous and latest amounts of a regular payment for the insight to trigger. Both regular_income_changed.minimum_absolute_change_threshold and regular_income_changed.minimum_percentage_change_threshold must be met to trigger. If not specified, a configured value will be used. Please note that including this request on a customer level will increase latency of this endpoint. Instead, we recommend to update the thresholds for your organisation by raising a support request.

Headers

X-Client-Id

string

required

The API Client Identifier (Service Application Identifier).

X-Customer-Id

uuid

required

A unique identifier for a Customer, as registered on Bud's platform.

X-Customer-Idempotent-Identifier

string

Use the internal client identifier, provided in the client_metadata object when creating the customer in Create Customer V3, in place of an X-Customer-Id header.

X-Customer-Secret

string

The Bud Customer secret used to encrypt customer data. This is required only if the customer secret is not already stored with Bud.

Responses

404

Insight not found. This can occur if the returned insight was invalidated by an account refresh or other change to customer data.

200OK