Skip to main content

List Accounts

Loading...
API endpoint path: /db-accounts/v1/accounts

Returns a list of financial accounts that the authenticated user is entitled to access. The response may include deposit, loan, investment, and related account types, subject to entitlement checks, data masking rules, and response field selection based on the requested view and OAuth scopes.

The endpoint supports optional filtering and cross‑account handling, and provides additional grouping and paging capabilities for Business Banking users with access to multiple locations.

Use this endpoint to:

  • Display an account summary or dashboard for a user
  • Retrieve account metadata for navigation, selection, or downstream workflows
  • Support retail and business banking use cases, including joint and cross‑user accounts

Behavior and capabilities:

  • Results are returned only for accounts the user is entitled to access.
  • Sensitive fields, such as account numbers, may be masked unless appropriate scopes are provided.
  • Optional OData filtering can be applied to narrow results by account attributes.
  • Cross‑account retrieval can be enabled or disabled to control inclusion of joint or cross‑user accounts.
  • For Business Banking users with multiple locations, accounts can be grouped by institution customer (location) with group‑level paging support.

Request​

Responses​

Success