Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

NatWest Group Account Access API

The Account Access API from NatWest Group — 2 operation(s) for account access.

NatWest Group Account Access 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 Access. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 3 operations across 2 paths, and defines 10 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.

3 operations 2 paths 10 schemas 1 DELETE1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.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 Account Access 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 3

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

Account Access 3
POST
/account-access-consents
Create Account Access Consents
CreateAccountAccessConsents 5 params body → 201400401403405406415429
GET
/account-access-consents/{ConsentId}
Get Account Access Consents
GetAccountAccessConsentsConsentId 6 params → 200400401403405406429500
DELETE
/account-access-consents/{ConsentId}
Delete Account Access Consents
DeleteAccountAccessConsentsConsentId 6 params → 204400401403405406429500

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are Links (5 properties), OBErrorResponse1 (4 properties), OBReadConsentResponse1 (4 properties), OBError1 (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:…
OBErrorResponse1
object
An array of detail error codes, and messages, and URLs to documentation to help remediation.
4 properties 3 required
OBReadConsentResponse1
object
4 properties 2 required
Meta
object
Meta Data relevant to the payload
3 properties
OBError1
object
4 properties 2 required
Links
object
Links relevant to the payload
5 properties 1 required
CreationDateTime
string
Date and time at which the resource was created.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses…
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…
OBRisk2
object
The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Account Info.
OBReadConsent1
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

natwest-account-access-api-openapi.yml Raw ↑

Other APIs NatWest Group publishes across the network.

NatWest Group Accounts 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