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

zopa Parties API

The Parties API from zopa — 2 operation(s) for parties.

zopa Parties API is one of 12 APIs that zopa 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 and API documentation.

This API exposes 2 operations across 2 paths, and defines 14 schemas. It is described by OpenAPI 3.0.0, at version 4.0.0.

Requests are made against a single base URL, /open-banking/v4.0/aisp.

2 operations 2 paths 14 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
4.0.0
Base URL
https://developer.openbanking-sandbox.zopa.com/open-banking/v4.0/aisp
Authentication
OAuth 2.0, OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 2

zopa 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 2

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

Parties 2
GET
/accounts/{AccountId}/party
Get Party
GetAccountsAccountIdParty 6 params → 200400401403404405406429
GET
/party
Get Party
GetParty 5 params → 200400401403404405406429

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are OBParty2 (7 properties), Links (5 properties), OBError1 (4 properties), OBErrorResponse1 (4 properties). Each schema is shown below with its type and property counts.

PartyId
string
A unique and immutable identifier used to identify the customer resource. This identifier has no meaning to the account owner.
OBInternalPartyType1Code
string
Party type, in a coded form. For a full list see OBInternalPartyType1Code in OBInternalCodeSet [here](https://github.com/OpenBankingUK/ExternalInternalCodeSets)
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…
OBErrorResponse1
object
An array of detail error codes, and messages, and URLs to documentation to help remediation.
4 properties 1 required
OBParty2
object
7 properties 1 required
Name_3
string
Name by which a party is known and which is usually used to identify that party.
OBReadParty2
object
3 properties 1 required
OBInternalLegalStructureType1Code
string
Legal standing of the party. For a full list refer to OBInternalLegalStructureType1Code in OBInternalCodeSet [here](https://github.com/OpenBankingUK/ExternalIn…
Meta
object
Meta Data relevant to the payload
3 properties
OBError1
object
4 properties 1 required
OBExternalStatusReason1Code
string
Low level textual error code, for all enum values see ExternalReason1Code [here](https://github.com/OpenBankingUK/ExternalInternalCodeSets)
FullLegalName
string
The full legal name of the party.
Links
object
Links relevant to the payload
5 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:…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zopa-parties-api-openapi.yml Raw ↑

Other APIs zopa publishes across the network.

zopa Account Access API
zopa Accounts API
zopa Balances API
zopa Beneficiaries API
zopa Direct Debits API
zopa Domestic Payments API
zopa Domestic Standing Orders API
zopa Offers API
zopa Standing Orders API
zopa Statements API
zopa Transactions API