GET /obp/v7.0.0/banks/BANK_ID/account-directory

OBPv6.0.0-getAccountDirectory Roles: CanGetAccountDirectoryAtOneBank(per bank) Account

Returns a list of accounts at the bank with identifiers and metadata.

This endpoint is designed for management UIs that need to list accounts without exposing sensitive data (balance and owners are excluded).

The response includes: account_id, bank_id, label, account_number, account_type, branch_id, account_routings, account_attributes and view_ids.

Possible custom url parameters for pagination:

limit=NUMBER ==> default value: 50
offset=NUMBER ==> default value: 0

eg1:?limit=100&offset=0

URL encoding: query parameter values containing &, =, +, #, %, or spaces must be URL-encoded (e.g. + → %2B, space → %20). Most other characters (including @ in emails) are safe unencoded, but encoding is always permitted.

sort_direction=ASC/DESC ==> default value: DESC.

eg2:?limit=100&offset=0&sort_direction=ASC

Authentication is Required

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

BANK_ID: gh.29.uk

{ "accounts": [ { "account_id": "8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "bank_id": "gh.29.uk", "label": "My Account", "account_number": "123456789", "account_type": "CURRENT", "branch_id": "BRANCH_1", "account_routings": [ { "scheme": "OBP", "address": "8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" } ], "account_attributes": [ { "type": "STRING", "code": "OVERDRAFT_LIMIT", "value": "1000" } ], "view_ids": [ "owner" ] } ] }