Get Account Directory at Bank
GET /obp/v7.0.0/banks/BANK_ID/account-directory
OBPv7.0.0-getAccountDirectory Roles: CanGetAccountDirectoryAtOneBank(per bank) Account
Returns the accounts at the bank with their identifiers, for management UIs that need to list accounts without exposing sensitive data: balances and owners are not included.
Each account has account_id, bank_id, label, account_number, account_type, branch_id, account_routings, account_attributes and view_ids, as in v6.0.0.
An account created through v7.0.0 Create Account also has metadata.created, the same object Create Account returned: at is when it was created, user_id the User who made the call and on_behalf_of_user_id the User it was made for. They differ when an application acting for a User, such as an AI agent, called with a Consent; see On Behalf Of. consent_reference_id is then the Consent's reference id, and is omitted when the caller acted for themselves. metadata is omitted for an account OBP holds no creation record for, such as one created by an earlier API version, by the Connector, or the settlement accounts created with the bank.
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
JSON response body fields (21)
- account_attributes
- account_id
- 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
- account_number
- 546387432
- account_routings
- account_type
- AC
- accounts
- address
- at
- at
- bank_id
- gh.29.uk
- branch_id
- DERBY6
- code
- 125
- created
- label
- My Account
- on_behalf_of_user_id
- on_behalf_of_user_id
- scheme
- OBP
- type
- user_id
- 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
- value
- 5987953
- view_ids
- view_ids
- consent_reference_id
- fd13b9af-4f74-4d52-a7f1-7c2c12f3aa11
- metadata
Example success response
{
"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"
],
"metadata": {
"created": {
"at": "2026-09-30T10:12:00Z",
"user_id": "a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f",
"on_behalf_of_user_id": "9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"consent_reference_id": "4c7e8f2a-1b3d-4e5f-9a6b-7c8d9e0f1a2b"
}
}
}
]
}Possible errors (4)
- OBP-20001: User not logged in. Authentication is required!
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.