NatWest Group Accounts API is one of 21 APIs that NatWest Group publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Accounts. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
2 operations
across 2 paths,
and defines 25 schemas.
It is described by OpenAPI 3.0.0, at version 3.1.11.
Requests are made against a single base URL, /open-banking/v3.1/aisp.
2 operations2 paths25 schemas2 GET
Metadata
The identity and technical contract details declared by the specification.
NatWest Group 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.
The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are OBAccount6 (13 properties), Links (5 properties), OBError1 (4 properties), OBErrorResponse1 (4 properties). Each schema is shown below with its type and property counts.
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:…
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 86…
Identification_1
string
Unique and unambiguous identification of the servicing institution.
OBErrorResponse1
object
An array of detail error codes, and messages, and URLs to documentation to help remediation.
4 properties3 required
Meta
object
Meta Data relevant to the payload
3 properties
OBError1
object
4 properties2 required
Links
object
Links relevant to the payload
5 properties1 required
OBExternalAccountSubType1Code
string
Specifies the sub type of account (product family group).
OBAccountStatus1Code
string
Specifies the status of account resource in code form.
OBExternalAccountType1Code
string
Specifies the type of account (personal or business).
OBExternalSwitchStatusCode
string
Specifies the switch status for the account, in a coded form.
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 res…
Identification_0
string
Identification assigned by an institution to identify an account. This identification is known by the account owner.
AccountId
string
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
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…
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…
OBExternalAccountIdentification4Code
string
Name of the identification scheme, in a coded form as published in an external list.
OBExternalFinancialInstitutionIdentification4Code
string
Name of the identification scheme, in a coded form as published in an external list.
OBReadAccount6
object
3 properties1 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 ti…
Description_0
string
Specifies the description of the account type.
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…
13 properties1 required
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…
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…
2 properties2 required
Nickname
string
The nickname of the account, assigned by the account owner in order to provide an additional means of identification of the account.
Specification
The full machine-readable OpenAPI contract behind this narrative.
