Retrieve Customer Characteristics

get deprecated

https://api-sandbox.thisisbud.com/v1/signal/customer-characteristics

Provides a list of potential scenarios where a customer might suffer some financial expense that cover the following:

Deprecation:

Support will cease for this endpoint on the 1st of December 2023 - please complete your migration to the Retrieve Customer Characteristics endpoints by that point in time. For further details, contact your Bud account manager or email [email protected].

Customer Characteristics	Description
`parent`	User has childcare transactions
`student_loan`	User is paying off a student loan
`pensioner`	User receives pension income
`saver`	User receives savings income and / or deposits money into a savings / investment account
`insurer`	User has one or more insurance policies
`overdraft_user`	User was in their overdraft at midnight on any day during a set period
`cash_user`	User has made cash deposits and / or cash withdrawals
`subscriber`	User has one or more subscriptions

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Headers

X-Client-Id

string

required

The API Client Identifier (Service Application Identifier).

X-Customer-Id

uuid

required

Bud Customer identifier

X-Customer-Secret

string

The Bud Customer secret used to encrypt customer data. This is optional only if the customer secret is already stored with Bud (i.e. the host_secret was set to true in the Customer Context when the customer was created).

X-From

string

Date (YYYY-MM-DD) from which the transactions should be returned from, this works in pair with the 'X-To' parameter

X-To

string

Date (YYYY-MM-DD) from which the transactions should be returned to, this works in pair with the 'X-From' parameter

X-Today

string

Date (YYYY-MM-DD) to treat as the current day. Use this with X-From and X-To to find historical warnings (e.g. warnings that you would have received last week)

X-Delta

number

≥ 0

Defaults to 3

Number of days error to match regular payments when they could be off by a few days from month to month. E.g. if your predicted rent payment is on 25th but you paid it on 23rd, a delta of 2 would treat your predicted transaction for 25th as Booked/Pending.

Responses

400

Bad Request that fails validations on headers & payload

401

Unauthorized (BearerToken in 'Authorization' header fails the authentication)

403

Forbidden

5XX

An unexpected error occurred on the server side

200The request was successfully processed