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 Parties API

The Parties API from NatWest Group — 3 operation(s) for parties.

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

This API exposes 3 operations across 3 paths, and defines 26 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 3 paths 26 schemas 3 GET

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 Parties 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 3 paths, the API surfaces 3 operations — 3 GET. Each is listed below with its method, path, parameters, and response codes.

Parties 3
GET
/accounts/{AccountId}/parties
Get Parties
GetAccountsAccountIdParties 6 params → 200400401403404405406429
GET
/accounts/{AccountId}/party
Get Parties
GetAccountsAccountIdParty 6 params → 200400401403404405406429
GET
/party
Get Parties
GetParty 5 params → 200400401403404405406429

Schemas 26

The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are OBParty2 (13 properties), Links (5 properties), OBErrorResponse1 (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:…
PhoneNumber_0
string
Collection of information that identifies a phone number, as defined by telecom services.
OBErrorResponse1
object
An array of detail error codes, and messages, and URLs to documentation to help remediation.
4 properties 3 required
EmailAddress
string
Address for electronic mail (e-mail).
OBExternalAccountRole1Code
string
A party’s role with respect to the related account.
OBParty2
object
13 properties 1 required
Meta
object
Meta Data relevant to the payload
3 properties
CountrySubDivision
string
Identifies a subdivision of a country eg, state, region, county.
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.
OBError1
object
4 properties 2 required
Links
object
Links relevant to the payload
5 properties 1 required
FullLegalName
string
Specifies a character string with a maximum length of 350 characters.
OBAddressTypeCode
string
Identifies the nature of the postal address.
OBReadParty3
object
3 properties 1 required
StreetName
string
Name of a street or thoroughfare.
PhoneNumber_1
string
Collection of information that identifies a mobile phone number, as defined by telecom services.
TownName
string
Name of a built-up area, with defined boundaries, and a local government.
OBPartyRelationships1
object
The Party's relationships with other resources.
1 property
PartyId
string
A unique and immutable identifier used to identify the customer resource. This identifier has no meaning to the account owner.
Name_3
string
Name by which a party is known and which is usually used to identify that party.
PartyNumber
string
Number assigned by an agent to identify its customer.
OBExternalPartyType1Code
string
Party type, in a coded form.
CountryCode
string
Nation with its own government, occupying a particular territory.
BuildingNumber
string
Number that identifies the position of a building on a street.
OBReadParty2
object
3 properties 1 required
OBExternalLegalStructureType1Code
string
Legal standing of the party.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

natwest-parties-api-openapi.yml Raw ↑

Other APIs NatWest Group publishes across the network.

NatWest Group Account Access API
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