Retrieve Accounts V3

Retrieves a list of a customer's connected accounts. The result can be filtered using the parameters outlined below.

Note: > > For more information on the Account object, please refer to our handy guide.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Use this parameter to filter the results returned on the currency associated with each result. Multiple values are accepted. If this parameter is not provided then results of any currency will be returned.

string

Use this parameter to filter the results returned on the provider associated with each result. Multiple values are accepted. If this parameter is not provided then results of any provider will be returned.

string

Use this parameter to filter the results returned on the account_type associated with each result. Multiple values are accepted. If this parameter is not provided then results of any account_type will be returned. Currently supported values include (but are not necessarily limited to):

  • auto_loan
  • boat_loan
  • brokerage
  • business_loan
  • certificate_of_deposit
  • charge_card
  • checking_account
  • credit_card
  • current_account
  • disability_insurance
  • e_money
  • health_insurance
  • home_equity_loan
  • investment
  • ira
  • liability_insurance
  • life_insurance
  • line_of_credit
  • loan
  • money_market
  • mortgage
  • other
  • personal_loan
  • pre_paid_card
  • property_insurance
  • roth
  • rv_loan
  • savings
  • student_loan
  • travel_insurance
  • vehicle_insurance
string

Use this parameter to filter the results returned on the usage_type associated with each result. Multiple values are accepted. If this parameter is not provided then results of any usage_type will be returned. Currently supported values include (but are not necessarily limited to):

  • personal
  • business
string

Use this parameter to filter the results returned on the holder_relationship_type associated with each result. Multiple values are accepted. If this parameter is not provided then results of any holder_relationship_type will be returned. Currently supported values include (but are not necessarily limited to):

  • sole
  • joint
  • delegate
  • unknown
boolean

Use this parameter to include all balances associated with each account. If this parameter is not provided then only the pending and booked balance will be returned where available.

Headers
string
required

The API Client Identifier (Service Application Identifier).

uuid
required

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

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.

Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Choose an example:
application/json