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 Event Subscriptions API

The Event Subscriptions API from UK Open Banking — 2 operation(s) for event subscriptions.

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

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

4 operations 2 paths 10 schemas 1 DELETE1 GET1 POST1 PUT

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 Event Subscriptions 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 4

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

Event Subscriptions 4
POST
/event-subscriptions
Create an Event Subscription
CreateEventSubscriptions 7 params body → 201400401403404405406409
GET
/event-subscriptions
Get an Event Subscription
GetEventSubscriptions 6 params → 200400401403404405406429
PUT
/event-subscriptions/{EventSubscriptionId}
Update an Event Subscription
ChangeEventSubscriptionsEventSubscriptionId 8 params body → 200400401403404405406415
DELETE
/event-subscriptions/{EventSubscriptionId}
Delete an Event Subscription
DeleteEventSubscriptionsEventSubscriptionId 7 params → 204400401403404405406429

Schemas 10

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

Meta
object
Meta Data relevant to the payload
3 properties
OBExternalStatusReason1Code
string
Low level textual error code, for all enum values see OBExternalStatusReason1Code in OBInternalCodeSet [here](https://github.com/OpenBankingUK/ExternalInternal…
Version
string
Version for the event notification.
OBEventSubscriptionResponse1
object
3 properties 1 required
Links
object
Links relevant to the payload
5 properties 1 required
OBEventSubscription1
object
1 property 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:…
OBErrorResponse1
object
An array of detail error codes, and messages, and URLs to documentation to help remediation.
4 properties 1 required
OBError1
object
4 properties 1 required
OBEventSubscriptionsResponse1
object
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

open-banking-uk-event-subscriptions-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 Event Subscriptions 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.