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

The Parties API from UK Open Banking — 3 operation(s) for parties.

UK Open Banking Parties 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 Parties. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a GitHub repository, and rate-limit docs.

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

3 operations 3 paths 34 schemas 3 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 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 for an AccountId
GetAccountsAccountIdParties 7 params → 200400401403404405406429
GET
/accounts/{AccountId}/party
Get Party for an AccountId
GetAccountsAccountIdParty 7 params → 200400401403404405406429
GET
/party
Get Party
GetParty 6 params → 200400401403404405406429

Schemas 34

The contract defines 34 schemas that model the data the API accepts and returns. The most detailed are OBPostalAddress7 (18 properties), OBParty2 (14 properties), Links (5 properties), OBErrorResponse1 (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.
PartyId
string
A unique and immutable identifier used to identify the customer resource. This identifier has no meaning to the account owner.
Meta
object
Meta Data relevant to the payload
3 properties
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…
Floor
string
Number that identifies the level within a building
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.
PhoneNumber_1
string
Collection of information that identifies a mobile phone number, as defined by telecom services.
OBInternalPartyType1Code
string
Party type, in a coded form. For a full list see OBInternalPartyType1Code in OBInternalCodeSet [here](https://github.com/OpenBankingUK/ExternalInternalCodeSets)
PartyNumber
string
Number assigned by an agent to identify its customer.
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…
OBInternalLegalStructureType1Code
string
Legal standing of the party. For a full list refer to OBInternalLegalStructureType1Code in OBInternalCodeSet [here](https://github.com/OpenBankingUK/ExternalIn…
FullLegalName
string
The full legal name of the party.
OBParty2
object
14 properties 1 required
StreetName
string
Name of a street or thoroughfare.
Links
object
Links relevant to the payload
5 properties 1 required
OBInternalAccountRole1Code
string
A party’s role with respect to the related account. For a full list refer to OBInternalAccountRole1Code in OBInternalCodeSet [here](https://github.com/OpenBank…
OBPostalAddress7
object
Information that locates and identifies a specific address, as defined by postal services.
18 properties
EmailAddress
string
Address for electronic mail (e-mail).
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…
PhoneNumber_0
string
Collection of information that identifies a phone number, as defined by telecom services.
Room
string
Information that locates and identifies a room to form part of an address
BuildingName
string
Name of a referenced building.
Name_3
string
Name by which a party is known and which is usually used to identify that party.
OBPartyRelationships1
object
The Party's relationships with other resources.
1 property
OBErrorResponse1
object
An array of detail error codes, and messages, and URLs to documentation to help remediation.
4 properties 1 required
BuildingNumber
string
Number that identifies the position of a building on a street.
OBReadParty2
object
3 properties 1 required
OBError1
object
4 properties 1 required
DistrictName
string
Number that of the regional area, known as a district, which forms part of an address
OBReadParty3
object
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

open-banking-uk-parties-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 Accounts 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
Where this information came from

This is an independent, third-party profile of UK Open Banking Parties 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.