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

NatWest Group Accounts API

The Accounts API from NatWest Group — 2 operation(s) for accounts.

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 Account. 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.2.0, at version 3.1.11.

Requests are made against a single base URL, /open-banking/v3.1/aisp.

2 operations 2 paths 25 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
3.1.11
Base URL
https://api.sandbox.natwest.com/open-banking/v3.1/aisp
Authentication
OAuth 2.0, OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 2

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.

Accounts 2
GET
/accounts
Get Accounts
GetAccounts 5 params → 200400401403405406429500
GET
/accounts/{AccountId}
Get Accounts
GetAccountsAccountId 6 params → 200400401403405406429500

Schemas 25

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.

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…
OBAccountStatus1Code
string
Specifies the status of account resource in code form.
AccountId
string
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
Nickname
string
The nickname of the account, assigned by the account owner in order to provide an additional means of identification of the account.
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 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 86…
Links
object
Links relevant to the payload
5 properties 1 required
OBExternalAccountIdentification4Code
string
Name of the identification scheme, in a coded form as published in an external list.
OBError1
object
4 properties 2 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…
OBReadAccount6
object
3 properties 1 required
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:…
OBErrorResponse1
object
An array of detail error codes, and messages, and URLs to documentation to help remediation.
4 properties 3 required
OBExternalAccountSubType1Code
string
Specifies the sub type of account (product family group).
OBExternalFinancialInstitutionIdentification4Code
string
Name of the identification scheme, in a coded form as published in an external list.
Identification_0
string
Identification assigned by an institution to identify an account. This identification is known by the account owner.
OBExternalAccountType1Code
string
Specifies the type of account (personal or business).
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…
OBExternalSwitchStatusCode
string
Specifies the switch status for the account, in a coded form.
Identification_1
string
Unique and unambiguous identification of the servicing institution.
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…
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…
Meta
object
Meta Data relevant to the payload
3 properties
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 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

natwest-accounts-api-openapi.yml Raw ↑

Other APIs NatWest Group publishes across the network.

NatWest Group Account Access API
NatWest Group Balances API
NatWest Group Beneficiaries API
NatWest Group Direct Debits API
NatWest Group Domestic Payments API
NatWest Group Domestic Scheduled Payments API
NatWest Group Domestic Standing Orders API
NatWest Group File Payments API
NatWest Group Funds Confirmations API
NatWest Group International Payments API
NatWest Group International Scheduled Payments API
NatWest Group International Standing Orders API
Where this information came from

This is an independent, third-party profile of NatWest Group 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.