Retrieve Characteristics associated with an individual Customer based on their financial data.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/bud-co:bud-co-retrieve-customer-characteristics-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: 'Bud API Services: Documentation Retrieve Customer…'
version: 2.10.10
description: '# Overview
## Introduction
Welcome to Bud''s API Platform documentation.'
contact:
name: Bud Support
email: help@thisisbud.com
url: https://www.thisisbud.com/
x-logo:
url: data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAATAAAABuCAQAAAAKAYdLAAAACXBIWXMAAC4jAAAuIwF4pT92AAAAB3RJTUUH4wQDDggcbXcx7wAABeJJREFUeNrt3W2IFVUcx/HvXRW1VdQedy1bZVfoYX0osVQyfSGElKbRA5oFIaIlhAkWUYm6gvqqDMHMoBeKlhayCCZC2AMRPay7aJrSZmauZhQqaj7t7u1Fi965987s7D1n7pk7/j73zX2Y85//mXt2Zu45Z2ZBREREREREREREREREREREREREREREREREREREREREREREREREROIiZSFGH+YxgsOs5U/X1bFiPDPpQT3bu1DmcaZyg+vErWpjD+s47zoN6Mte0qRJc4Iq18lYMJv2jvosD11mRUeJpD32UO7664BFGQl94DoZY704fbU2rQwKVWYwbc6bQlSPBaYbtMz4K7nP53lpGkK/q8+7MTxUmeEWtmJcGX+j5psmM0I3l9vCirKAV36OuE46QsbfaHL/9opnL9tcpxBf3V0nkAgzWMRj9HadhrH+3Gk7pBqYDZdY3oXfnHE2gc1U2gyoQ6Rk+pKZdgOqgYnXF7TYDGe3gcWgW85QH9cJxMAVm8HsNrBqhhV1U9g33XUCzo1gsM1wdhtYio8ZWsytYdksFrpOwbGhbLYb0PavyLs5wA+c9v28lRa+Zzt/+y5RwwKqaOCdgCjZRvEit/A1a7jou8xwJjOMAb7D+ylqqCmw1imeZ0oCBrv7Mzp+/QofFTDCdZG13Jw3Wi1nOpbZT9+QGUziUkeZ3T49z+P4pqCRuCkhM1jjfMwwqsdG182rsAaWJs0JxuWJ9knGEq+EzODHjDLTcj5NsbjgwehwDazm6vyL5D2MG5i7booKdjE25917M57XhoxUG1hmJUsjrmWtlVl18ZQ2DeCyH6ycT7kpIJ+wuQWVeZJXI69HcpsXHDQN4LajtZIlkcbvzWqn9St1R3nPNIT93wzt/MSZPO+nqKA65699Nos5FdHmgZkMzHnvIj9zLm9+Q7jd0nqP8VtkdSqWNppYxT+u08g+yW8OnKRXw4ac08hnPUscyvjkw5AZXM4os9jzyY6sdZ3h5YC++jLm0lrASf50T5krzEn0QbOLbB8in2FvwKfNPJczCXd0hLV7wPPqL8bybt691//aWWfhkPo2681PjZPDbgP7lYZOl1nNJs9rW4elXD2zfkK8wIFOy2w1XuuWyOpTkuw2sHOhlqrzvIqu59gbuYEdIcqcjSyb65SLX5EHOepgrbuKtJ6nHNQtxtx0U5xM8DoXMkez7K5xM7Tp4iS4WOvszvss5feSP9Fvo5EVnDDfHGJfpd157Y48xFRGmfaEaWcu/qqYZxpCDcxcqR8Mg9xlGkANzNz+BDcx4zEJNTBzv5gPCSeXTvJtmM+3PJqIKdNj6GE3pJsG5mIwOMp1ptnABgd1sq+G7ebnXZncHCKjG3+M1zpLTzMz7AZ00cBG5pmlFb3JmkQTSpPd21HZbWD9Qy21zPPK/zricNH6+B7mvZFreTpEtAFWt0dpsnoWZreBVTG+kyVS1GVN4/vDd9lJVIRY5yzfPdPlrPHHdTwYItr1bkLcTia8M1qPM9F3yRRjcuaYprNmHxzyfNbQyQlnGTM47ynhndFan7WuCywLODz35I2sC9DCXheZHBNpsXvZmu1fkZXs5rjPnPzb8hyAzrIzINr9HOBIwNXat+ZcleS1hame1714izc55jNvbVDBtz7pyWuJuI15P/tnx1F0UwzsQpprO5nil2KIQSZbqcspnwp57+iu2MQT1mMmhNue/MMR3xfwMi8VYRhnmJqXP/MG1lZwyVNMy9l/FR4tf/mdvB553Uz2sXFn+n1YaGCNBZZr5mH25by7xzCb3PKrmM+lgmK1BV4hdc0+2g2zjq8m1wlAOY1dvqXGKep87oZYzUmDW3Vs8+myuIf6Am6AsiT0Nljp/CYl0Twaze9ZaaN3u5w5jAy5L2ylhe/4nAu+S1Qwl+oCsrjCV2wM2KXfwSPUcmPIGv9LPZ91Ye1TEnEb80ztNLE+Dv8MS0RERERERERERERERERERERERERERERERERERERERERERERERERs+Q/rhi5WauEgfQAAAABJRU5ErkJggg==
servers:
- url: https://api-sandbox.thisisbud.com
tags:
- name: Retrieve Customer Characteristics
x-displayName: Retrieve Customer Characteristics
description: Retrieve Characteristics associated with an individual Customer based on their financial data.
paths:
/characteristics/v1/customer:
get:
tags:
- Retrieve Customer Characteristics
summary: Retrieve Customer Characteristics
description: 'Retrieves a collection of characteristics associated with an individual Customer.
For data on why an individual characteristic applies to a Customer, use the relevant detailed endpoint.
The currently supported characteristics are:
| Characteristic | Description |
|:---------------|:-----------------------------------------------------------|
| `credit_card` | Customer has made credit card repayments |
| `loan` | Customer has made loan repayments (excluding credit cards) |
| `overdraft` | Customer has paid overdraft fees |
| `saver` | Customer has savings transactions |
New characteristics will be released and added to this list without a breaking change notice.'
operationId: characteristics_v1_customer_get
security:
- OAuth2: []
parameters:
- $ref: '#/components/parameters/ClientId'
- $ref: '#/components/parameters/CustomerId'
- $ref: '#/components/parameters/CustomerIdempotentIdentifier'
- $ref: '#/components/parameters/CustomerSecret'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GetCustomerCharacteristicsResponse'
examples:
Multiple Characteristics:
value:
operation_id: characteristics_v1_customer_get
data:
- type: credit_card
link: characteristics/v1/customer/credit_card
- type: loan
link: characteristics/v1/customer/loan
- type: overdraft
link: characteristics/v1/customer/overdraft
- type: saver
link: characteristics/v1/customer/saver
No Characteristics:
value:
operation_id: characteristics_v1_customer_get
data: []
'401':
description: Unauthorised request
5XX:
description: An unexpected error occurred on the server side
/characteristics/v1/customer/credit-card:
get:
tags:
- Retrieve Customer Characteristics
summary: Retrieve Customer Characteristics - Credit Card
description: Retrieves detailed information for a customer that marks them as a credit card user.
operationId: characteristics_v1_customer_credit_card_get
security:
- OAuth2: []
parameters:
- $ref: '#/components/parameters/ClientId'
- $ref: '#/components/parameters/CustomerId'
- $ref: '#/components/parameters/CustomerIdempotentIdentifier'
- $ref: '#/components/parameters/CustomerSecret'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GetCreditCardCharacteristicsResponse'
example:
operation_id: characteristics_v1_customer_credit_card_get
data:
credit_card_transactions:
- transaction_id: 864a3efc-6104-4dde-99a0-c3d91a8bcecf
account_id: ad7d5904-39ab-4736-b726-5792c7a2146e
credit_debit_indicator: debit
description: CREDIT CARD PAYMENT
provider: BankOfBud
status: booked
amount:
value: '1234.56'
currency: GBP
date_time: '2023-07-03T10:00:00Z'
enrichments:
categories:
l1:
slug: borrowing_and_loans
confidence: '0.99'
l2:
slug: credit_cards
confidence: '0.99'
credit_card_transaction_totals:
- amount:
value: '1234.56'
currency: GBP
credit_debit_indicator: debit
'401':
description: Unauthorised request
5XX:
description: An unexpected error occurred on the server side
/characteristics/v1/customer/loan:
get:
tags:
- Retrieve Customer Characteristics
summary: Retrieve Customer Characteristics - Loan
description: Retrieves detailed information for a customer that marks them as a loan user.
operationId: characteristics_v1_customer_loan_get
security:
- OAuth2: []
parameters:
- $ref: '#/components/parameters/ClientId'
- $ref: '#/components/parameters/CustomerId'
- $ref: '#/components/parameters/CustomerIdempotentIdentifier'
- $ref: '#/components/parameters/CustomerSecret'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GetLoanCharacteristicsResponse'
example:
operation_id: characteristics_v1_customer_loan_get
data:
loan_transactions:
- transaction_id: 864a3efc-6104-4dde-99a0-c3d91a8bcecf
account_id: ad7d5904-39ab-4736-b726-5792c7a2146e
credit_debit_indicator: debit
description: CAR LOAN REPAYMENT
provider: BankOfBud
status: booked
amount:
value: '1234.56'
currency: GBP
date_time: '2023-07-03T10:00:00Z'
enrichments:
categories:
l1:
slug: borrowing_and_loans
confidence: '0.92'
l2:
slug: vehicle_loan
confidence: '0.80'
loan_transaction_totals:
- amount:
value: '1234.56'
currency: GBP
credit_debit_indicator: debit
'401':
description: Unauthorised request
5XX:
description: An unexpected error occurred on the server side
/characteristics/v1/customer/overdraft:
get:
tags:
- Retrieve Customer Characteristics
summary: Retrieve Customer Characteristics - Overdraft
description: Retrieves detailed information for a customer that marks them as an overdraft user.
operationId: characteristics_v1_customer_overdraft_get
security:
- OAuth2: []
parameters:
- $ref: '#/components/parameters/ClientId'
- $ref: '#/components/parameters/CustomerId'
- $ref: '#/components/parameters/CustomerIdempotentIdentifier'
- $ref: '#/components/parameters/CustomerSecret'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GetOverdraftCharacteristicsResponse'
example:
operation_id: characteristics_v1_customer_overdraft_get
data:
overdraft_transactions:
- transaction_id: 864a3efc-6104-4dde-99a0-c3d91a8bcecf
account_id: ad7d5904-39ab-4736-b726-5792c7a2146e
credit_debit_indicator: debit
description: OVERDRAFT FEE
provider: BankOfBud
status: booked
amount:
value: '12.34'
currency: GBP
date_time: '2023-07-03T10:00:00Z'
enrichments:
categories:
l1:
slug: banking
confidence: '0.92'
l2:
slug: overdraft_fees
confidence: '0.80'
overdraft_transaction_totals:
- amount:
value: '12.34'
currency: GBP
credit_debit_indicator: debit
'401':
description: Unauthorised request
5XX:
description: An unexpected error occurred on the server side
/characteristics/v1/customer/saver:
get:
tags:
- Retrieve Customer Characteristics
summary: Retrieve Customer Characteristics - Saver
description: Retrieves detailed information for a customer that marks them as a saver.
operationId: characteristics_v1_customer_saver_get
security:
- OAuth2: []
parameters:
- $ref: '#/components/parameters/ClientId'
- $ref: '#/components/parameters/CustomerId'
- $ref: '#/components/parameters/CustomerIdempotentIdentifier'
- $ref: '#/components/parameters/CustomerSecret'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GetSaverCharacteristicsResponse'
example:
operation_id: characteristics_v1_customer_saver_get
data:
saver_transactions:
- transaction_id: 864a3efc-6104-4dde-99a0-c3d91a8bcecf
account_id: ad7d5904-39ab-4736-b726-5792c7a2146e
credit_debit_indicator: debit
description: SAVINGS
provider: BankOfBud
status: booked
amount:
value: '150.00'
currency: GBP
date_time: '2023-07-03T10:00:00Z'
enrichments:
categories:
l1:
slug: pensions_savings_and_investments
confidence: '0.99'
l2:
slug: savings
confidence: '0.99'
saver_transactions_totals:
- amount:
value: '12.34'
currency: GBP
credit_debit_indicator: debit
'401':
description: Unauthorised request
5XX:
description: An unexpected error occurred on the server side
components:
schemas:
TransactionTotal:
type: object
description: Totals of all included transactions for the specified currency.
required:
- amount
- credit_debit_indicator
properties:
amount:
$ref: '#/components/schemas/BudAmount'
credit_debit_indicator:
type: string
description: Credit/Debit Indicator
enum:
- credit
- debit
GetCreditCardCharacteristicsResponse:
title: Get Credit Card Customer Characteristics Response
type: object
required:
- operation_id
- data
properties:
operation_id:
type: string
enum:
- characteristics_v1_customer_credit_card_get
data:
type: object
properties:
credit_card_transactions:
type: array
items:
$ref: '#/components/schemas/CustomerCharacteristicTransaction'
credit_card_transaction_totals:
type: array
items:
$ref: '#/components/schemas/TransactionTotal'
GetOverdraftCharacteristicsResponse:
title: Get Overdraft Customer Characteristics Response
type: object
required:
- operation_id
- data
properties:
operation_id:
type: string
enum:
- characteristics_v1_customer_overdraft_get
data:
type: object
properties:
overdraft_transactions:
type: array
items:
$ref: '#/components/schemas/CustomerCharacteristicTransaction'
overdraft_transaction_totals:
type: array
items:
$ref: '#/components/schemas/TransactionTotal'
BudMonetaryValue:
title: Monetary Value
description: "The value of the monetary amount. The value is formatted with the number of decimal places for the respective currency. \n\nExample: `10.98`\n"
type: string
GetCustomerCharacteristicsResponse:
title: Retrieve Customer Characteristics Response
type: object
required:
- operation_id
- data
properties:
operation_id:
type: string
enum:
- characteristics_v1_customer_get
data:
type: array
items:
$ref: '#/components/schemas/CustomerCharacteristicSimple'
CustomerCharacteristicSimple:
title: Customer Characteristic
type: object
properties:
type:
title: Characteristic Type
type: string
description: 'The type of customer characteristic. Currently supported values include:
- `credit_card`
- `loan`
- `overdraft`
- `saver`
However clients integrating with this endpoint should expect more to be added without notice.
'
link:
title: Characteristic Details Link
type: string
description: The URL to follow to get detailed Characteristic information about the customer.
CustomerCharacteristicTransaction:
title: Customer Characteristic Transaction
type: object
description: A financial transaction
required:
- transaction_id
- account_id
- description
- amount
- credit_debit_indicator
- status
- date_time
properties:
transaction_id:
type: string
description: Unique identifier for the transaction. May be mutable depending on original ingestion source.
account_id:
type: string
description: Identifier for the account associated with the transaction.
provider:
type: string
description: Name of the transaction source provider. Optional as it may not have been supplied when using first party data.
description:
type: string
description: Description of the transaction.
credit_debit_indicator:
type: string
description: Credit/Debit Indicator
enum:
- credit
- debit
status:
type: string
description: Status of the transaction. Defaults to booked.
enum:
- booked
- pending
amount:
$ref: '#/components/schemas/BudAmount'
date_time:
type: string
description: Date of the transaction compliant with RFC3339.
enrichments:
type: object
description: Contextual enrichments associated with a Transaction
properties:
categories:
$ref: '#/components/schemas/components_schemas-Categories'
Category:
title: Category
type: object
description: Category associated with a Transaction
required:
- slug
- confidence
properties:
slug:
type: string
description: Unique human readable identifier of the category. Not subject to version control.
confidence:
type: string
description: Degree of belief of correct assignment, expressed as a probability.
GetSaverCharacteristicsResponse:
title: Get Saver Customer Characteristics Response
type: object
required:
- operation_id
- data
properties:
operation_id:
type: string
enum:
- characteristics_v1_customer_saver_get
data:
type: object
properties:
saver_transactions:
type: array
items:
$ref: '#/components/schemas/CustomerCharacteristicTransaction'
saver_transaction_totals:
type: array
items:
$ref: '#/components/schemas/TransactionTotal'
BudCurrency:
title: Currency
description: 'The three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) of the monetary amount.
Example: `GBP`
'
type: string
BudAmount:
title: Standard Bud Amount
type: object
description: The monetary amount.
required:
- value
- currency
properties:
value:
$ref: '#/components/schemas/BudMonetaryValue'
currency:
$ref: '#/components/schemas/BudCurrency'
components_schemas-Categories:
title: Categories
type: object
description: 'Categories enrichment associated with a Transaction, as generated by Bud''s artificial intelligence models.
Currently two levels of category are supported, with `l1` being a coarse-grained category level and `l2` being more refined.
'
properties:
l1:
$ref: '#/components/schemas/Category'
description: Level 1 Category
l2:
$ref: '#/components/schemas/Category'
description: Level 2 Category
GetLoanCharacteristicsResponse:
title: Get Loan Customer Characteristics Response
type: object
required:
- operation_id
- data
properties:
operation_id:
type: string
enum:
- characteristics_v1_customer_loan_get
data:
type: object
properties:
loan_transactions:
type: array
items:
$ref: '#/components/schemas/CustomerCharacteristicTransaction'
loan_transaction_totals:
type: array
items:
$ref: '#/components/schemas/TransactionTotal'
parameters:
CustomerId:
in: header
name: X-Customer-Id
schema:
type: string
format: uuid
required: true
description: A unique identifier for a Customer, as registered on Bud's platform.
example: c3339af9-2426-44d4-9c4d-ddb8fd281e23
ClientId:
in: header
name: X-Client-Id
schema:
type: string
required: true
description: The API Client Identifier (Service Application Identifier).
example: 8711bbef-b357-4c2d-97ca-0d9df4206e9a
CustomerIdempotentIdentifier:
in: header
name: X-Customer-Idempotent-Identifier
schema:
type: string
description: '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.
'
CustomerSecret:
in: header
name: X-Customer-Secret
schema:
type: string
required: false
description: The Bud Customer secret used to encrypt customer data. This is required only if the customer secret is not already stored with Bud.
securitySchemes:
Basic:
type: http
scheme: basic
OAuth2:
type: oauth2
flows:
clientCredentials:
tokenUrl: /v1/oauth/token
scopes: {}
description: "\nAuthentication flow:\n\n1. Perform OAuth2 Client Credentials authentication using API Credentials (`client_id`,`client_secret`) to obtain an `access_token` against `/v1/oauth/token` endpoint,\n2. Use `access_token` as Bearer Authorisation for every other API request,\n3. Include `X-Client-Id` (=client_id) within the header of every API request,\n4. Note that some of the requests may also require `X-Customer-Id` to be provided within the request header.\n\n### Examples\nObtain OAuth2 `access_token` and `refresh_token` using `grant_type=client_credentials` and HTTP Basic auth header\n\n```\ncurl --basic --user {{client_id}}:{{client_secret}} \\\n -X POST https://api-sandbox.thisisbud.com/v1/oauth/token \\\n -H 'Content-Type: application/x-www-form-urlencoded' \\\n -d grant_type=client_credentials\n```\n\nSuccessful response:\n```\n{\n \"operation_id\": \"oauth_token_post\",\n \"data\": {\n \"access_token\": \"dd0c17e3fd6d2ce94aa091257a3ea393b4f9b5cf3d3e998f07dc9826da86ff15\",\n \"token_type\": \"bearer\",\n \"expires_in\": 3600,\n \"refresh_token\": \"fac32cca7559d9f6e8f1dfe9a99c71fa1dcfeb482bedf287d7934d2667ae54b3\"\n }\n}\n```\n\nRefresh `access_token` token using `refresh_token` against `/v1/oauth/token` endpoint with `grant_type=refresh_token`\n\n```\ncurl -X POST \\\n https://api-sandbox.thisisbud.com/v1/oauth/token \\\n -H 'Content-Type: application/x-www-form-urlencoded' \\\n -H 'X-Client-Id: {{client_id}}' \\\n -d 'grant_type=refresh_token&refresh_token={{refresh_token}}'\n```\n\nSuccessful response:\n```\n{\n \"operation_id\": \"oauth_token_post\",\n \"data\": {\n \"access_token\": \"cc0c17e3fd6d2ce94aa091257a3ea393b4f9b5cf3d3e998f07dc9826da86ff94\",\n \"token_type\": \"bearer\",\n \"expires_in\": 3600,\n \"refresh_token\": \"ffc30cca7559d9f6e8f1dfe9a99c71fa1dcfeb482bedf287d7934d2667ae54b3\"\n }\n}\n```\n"
x-tagGroups:
- name: ''
tags:
- OAuth2
- Authentication
- name: ''
tags:
- Create a Connection
- Manage a Connection
- Ingest First Party Data
- Connect API
- name: ''
tags:
- Manage Customers
- Customers API
- name: ''
tags:
- Enrichment Resources
- Enrichment Totals
- Enrichment API
- name: ''
tags:
- Retrieve Financial Data
- Manage Financial Data
- Correct Financial Data
- Financial Data API
- name: ''
tags:
- Spending Budgets
- Savings Goals V2
- Goals API
- name: ''
tags:
- Regular Payments Finder
- Income Finder
- Loan Finder
- Debt Collection Finder
- Product Finder
- Subscription Finder
- Smart Finders API
- name: ''
tags:
- Transaction Search
- Intelligent Search API
- name: ''
tags:
- Customer Applications
- Customer Application Links
- Aggregation Buckets
- Retrieve Affordability Report V2
- Retrieve Affordability Report
- Retrieve Affordability Risk Insights
- Assess API
- name: ''
tags:
- Initiate Payment - Bud license
- Initiate Payment - Client license
- Manage Payments
- Payments API
- name: ''
tags:
- Retrieve Customer Characteristics
- Characteristics API
- name: ''
tags:
- Retrieve Actionable Insights
- Custom Insights
- Frontend Widgets
- Insights API