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

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

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

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

3 operations 2 paths 11 schemas 1 DELETE1 GET1 POST

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 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 11

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

OBErrorResponse1
object
An array of detail error codes, and messages, and URLs to documentation to help remediation.
4 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…
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
Meta
object
Meta Data relevant to the payload
3 properties
OBError1
object
4 properties 1 required
OBReadConsentResponse1
object
4 properties 2 required
OBExternalStatusReason1Code
string
Low level textual error code, for all enum values see ExternalReason1Code [here](https://github.com/OpenBankingUK/ExternalInternalCodeSets)
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 re…
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-account-access-api-openapi.yml Raw ↑

Other APIs zopa publishes across the network.

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 Parties API
zopa Standing Orders API
zopa Statements API
zopa Transactions API