Skip to main content

Get Account by ID

Loading...
API endpoint path: /db-accounts/v1/accounts/{accountId}

Returns detailed information for a specific financial account that the authenticated user is entitled to access. The response includes account balances, status indicators, and available actions, and is subject to entitlement checks, data masking rules, and response field selection based on the requested view and OAuth scopes.

This endpoint supports both retail and business banking scenarios and allows optional scoping for Business Banking users with access to multiple locations.

Use this endpoint to:

  • Display detailed account information for a selected account
  • Retrieve current balances, account status, and permitted actions
  • Support retail and business banking workflows, including joint and cross‑user account access

Behavior and capabilities:

  • The account is returned only if the authenticated user is entitled to access it.
  • Sensitive fields, such as account numbers, may be masked unless appropriate scopes are provided.
  • The fields included in the response depend on the requested response view and client entitlements.
  • For Business Banking users, results can be scoped to a specific institution customer (location) when applicable.
  • Cross‑account handling may include joint or cross‑user accounts based on request configuration.

Request​

Responses​

Success