Yorkshire Building Society Event Subscriptions API
OBIE Read/Write Event Subscriptions API v3.1.2 - lets an onboarded TPP create, read and delete event subscriptions so it can receive aggregated-polling and real-time event notifications (for example consent revocation) for YBS and Chelsea Building Society Open Banking resources. FAPI-secured (OAuth2/OIDC, mTLS).
Yorkshire Building Society Event Subscriptions API is one of 6 APIs that Yorkshire Building Society publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Event Subscriptions, Notifications, and Open Banking. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.
This API exposes 4 operations across 2 paths, and defines 9 schemas. It is described by OpenAPI 3.0.1, at version v3.1.2.
Requests are made against the base URL https://ob-ybs.api.ybs.co.uk/open-banking/v3.1/aisp.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Yorkshire Building Society Event Subscriptions API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (TPPOAuth2Security) using the clientCredentials flow, exposing 3 scopes.
TPPOAuth2Security— TPP client credential authorisation flow with the ASPSP
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.
Schemas 9
The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are Links (5 properties), OBErrorResponse1 (4 properties), OBError1 (4 properties), OBEventSubscriptionsResponse1 (3 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Yorkshire Building Society 5
Other APIs Yorkshire Building Society publishes across the network.