How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

UK Open Banking Accounts API

The Accounts API from UK Open Banking — 2 operation(s) for accounts.

UK Open Banking Accounts API is one of 42 APIs that UK Open Banking publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Account. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a GitHub repository, and rate-limit docs.

This API exposes 2 operations across 2 paths, and defines 45 schemas. It is described by OpenAPI 3.0.0, at version 4.0.1.

Requests are made against a single base URL, /open-banking/v4.0/aisp.

2 operations 2 paths 45 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
4.0.1
Base URL
https://{aspsp-host}/open-banking/v4.0
Authentication
OAuth 2.0, OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 2

UK Open Banking Accounts API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (TPPOAuth2Security) using the clientCredentials flow, exposing 1 scope. It supports OAuth 2.0 (PSUOAuth2Security) using the authorizationCode flow, exposing 1 scope.

  • TPPOAuth2Security — TPP client credential authorisation flow with the ASPSP
  • PSUOAuth2Security — OAuth flow, it is required when the PSU needs to perform SCA with the ASPSP when a TPP wants to access an ASPSP resource owned by the PSU

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

Accounts 2
GET
/accounts
Get Accounts
GetAccounts 6 params → 200400401403405406429500
GET
/accounts/{AccountId}
Get an Account by AccountId
GetAccountsAccountId 7 params → 200400401403405406429500

Schemas 45

The contract defines 45 schemas that model the data the API accepts and returns. The most detailed are OBPostalAddress7 (18 properties), OBAccount6 (14 properties), Links (5 properties), OBError1 (4 properties). Each schema is shown below with its type and property counts.

TownName
string
Name of a built-up area, with defined boundaries, and a local government.
PostCode
string
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
Meta
object
Meta Data relevant to the payload
3 properties
OBInternalAccountStatus1Code
string
Specifies the status of account resource in code form. For a full list of enumeration values refer to OBInternalAccountStatus1Code in OBInternalCodeSet [here](…
AccountId
string
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
StatusUpdateDateTime
string
Date and time at which the resource status was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in re…
Floor
string
Number that identifies the level within a building
LEI
string
Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Finan…
PostBox
string
Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.
Name_0
string
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account n…
OBAccount6
object
Unambiguous identification of the account to which credit and debit entries are made. The following fields are optional only for accounts that are switched: Da…
14 properties 1 required
OpeningDate
string
Date on which the account and related basic services are effectively operational for the account owner. All dates in the JSON payloads are represented in ISO 8…
Identification_0
string
Identification assigned by an institution to identify an account. This identification is known by the account owner.
OBFrequency2
string
For a full list of enumeration values refer to OBFrequency2Code in OBInternalCodeSet [here](https://github.com/OpenBankingUK/ExternalinternalCodeSets)
SecondaryIdentification
string
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally ident…
UnitNumber
string
Number that identifies the unit of a specific address .
OBExternalStatusReason1Code
string
Low level textual error code, for all enum values see OBExternalStatusReason1Code in OBInternalCodeSet [here](https://github.com/OpenBankingUK/ExternalInternal…
CareOf
string
The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail f…
OBInternalAccountType1Code
string
Specifies the type of account (personal or business). For a full list of enumeration values refer to 'OBInternalAccountType1Code' in OBInternalCodeSet [here](h…
OBBranchAndFinancialInstitutionIdentification5_0
object
Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on t…
3 properties 2 required
OBInternalFinancialInstitutionIdentification4Code
string
Name of the identification scheme, in a coded form as published in an external list. For a full list of enumeration values refer to OBInternalFinancialInstitut…
OBCommunicationMethod
string
For a full list of enumeration values see OBExternalCommunicationMethod2Code in OBInternalCodeSet [here](https://github.com/OpenBankingUK/ExternalinternalCodeS…
Nickname
string
The nickname of the account, assigned by the account owner in order to provide an additional means of identification of the account.
StreetName
string
Name of a street or thoroughfare.
Description_0
string
Specifies the description of the account type.
Links
object
Links relevant to the payload
5 properties 1 required
MaturityDate
string
Maturity date of the account. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the t…
OBPostalAddress7
object
Information that locates and identifies a specific address, as defined by postal services.
18 properties
ISODateTime
string
All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below:…
OBAddressType2Code
string
Identifies the nature of the postal address. For a full set of codes see OBAddressType2Code in OBInternalCodeSet [here](https://github.com/OpenBankingUK/Extern…
StatementFrequencyAndFormat
array
Room
string
Information that locates and identifies a room to form part of an address
OBInternalSwitchStatusCode
string
Specifies the switch status for the account, in a coded form. For a full list of enumeration values refer to OBInternalSwitchStatusCode in OBInternalCodeSet [h…
Identification_1
string
Unique and unambiguous identification of the servicing institution.
OBFileFormat
string
For a full list of enumeration values refer to ExternalDocumentFormat1Code in ISOExternalCodeSet [here](https://github.com/OpenBankingUK/ExternalinternalCodeSe…
Name_1
string
Name by which an agent is known and which is usually used to identify that agent.
BuildingName
string
Name of a referenced building.
OBExternalAccountSubType1Code
string
Specifies the sub type of account (product family group) For a full list of enumeration values refer to OBExternalCashAccountType1Code OBInternalCodeSet [here]…
OBReadAccount6
object
3 properties 1 required
OBErrorResponse1
object
An array of detail error codes, and messages, and URLs to documentation to help remediation.
4 properties 1 required
ActiveOrHistoricCurrencyCode_0
string
Identification of the currency in which the account is held. Usage: Currency should only be used in case one and the same account number covers several currenc…
BuildingNumber
string
Number that identifies the position of a building on a street.
OBError1
object
4 properties 1 required
DistrictName
string
Number that of the regional area, known as a district, which forms part of an address
OBInternalAccountIdentification4Code
string
Name of the identification scheme, in a coded form as published in an external list. For a full list of enumeration values refer to OBInternalAccountIdentifica…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

open-banking-uk-accounts-api-openapi.yml Raw ↑

Other APIs UK Open Banking publishes across the network.

UK Open Banking Open Data API
UK Open Banking Dynamic Client Registration API
UK Open Banking Directory API
UK Open Banking Account Access Consents API
UK Open Banking ATM API
UK Open Banking Balances API
UK Open Banking BCA API
UK Open Banking Beneficiaries API
UK Open Banking Branch API
UK Open Banking CCC API
UK Open Banking Direct Debits API
UK Open Banking Domestic Payment Consents API
Where this information came from

This is an independent, third-party profile of UK Open Banking Accounts API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.