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

Yapily Institutions API

Discover and inspect the 2,000+ supported UK and European banks (ASPSPs), including supported features, payment methods, countries, BIC/BBAN identifiers, media assets, and authentication mechanisms.

Yapily Institutions API is one of 16 APIs that Yapily publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Institutions, ASPSP, and Open Banking. The published artifact set on APIs.io includes API documentation, an OpenAPI specification, and 1 JSON Schema.

This API exposes 2 operations across 2 paths, and defines 20 schemas. It is described by OpenAPI 3.0.1, at version 12.4.0.

Requests are made against a single base URL, https://api.yapily.com.

2 operations 2 paths 20 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
12.4.0
Base URL
https://api.yapily.com
Authentication
HTTP Basic
Resource Areas
1

Authentication & Security 1

Yapily Institutions API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • basicAuth — Use HTTP Basic Authentication with your Application ID as username and Application Secret as password. Manage credentials in the [Yapily Console](https://conso…

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.

Institutions 2

An Institution object represents any Account Serving Payment Servicing Provider (ASPSP) that has been integrated and is accessible through the Yapily APIs (ASPSPs are entities tha…

GET
/institutions
Get Institutions
getInstitutions → 200default
GET
/institutions/{institutionId}
Get Institution
getInstitution 1 param → 200default

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are Institution (8 properties), RawRequest (8 properties), ApiListResponseOfInstitution (7 properties), FilteredClientPayloadListInstitution (6 properties). Each schema is shown below with its type and property counts.

CredentialsType
string
The type of credentials required to register the Institution
Media
object
Details of the media held for the Institution
2 properties
ApiError
object
Provides details of the error that has occurred.
6 properties
Institution
object
Typically, a bank or business unit within a bank e.g. (AIB Business, AIB Ireland, AIB UK).
8 properties
RawResponse
object
[DEPRECATED] Interaction (raw request and response) that occurred with the Institution in order to fulfil a request.
5 properties
FeatureEnum
string
Used to describe what functions are supported by the associated Institution. For more information on each feature, see the following links: - [Financial Data F…
InstitutionError
object
Raw error details provided by the Institution, when it was the error source.
2 properties
ApiResponseError
object
Used to return errors from the bank from each request - 400 - Returned by any POST endpoint when the body does not conform to the contract - 401 - Returned by…
2 properties
ResponseForwardedData
object
2 properties
Country
object
An array of Country denoting which regions the Institution provides coverage for
3 properties
Pagination
object
3 properties
EnvironmentType
string
The environment type. See [Institution Configuration](/introductionpages/key-concepts/institutions/configuration) for more information
ApiListResponseOfInstitution
object
7 properties
ApiCall
object
Next
object
4 properties
FilterAndSort
object
6 properties
ResponseListMeta
object
3 properties
FilteredClientPayloadListInstitution
object
6 properties
RawRequest
object
8 properties
SortEnum
string
The attribute on which resources / records returned should be sorted. Valid options for the sort parameter.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yapily-institutions-api-openapi.yml Raw ↑

Other APIs Yapily publishes across the network.

Yapily Consents and Authorisations API
Yapily Payments API (PIS)
Yapily Data Plus API
Yapily Application Beneficiaries API
Yapily Application Management API
Yapily Authorisations API
Yapily Constraints API
Yapily Financial Data API
Yapily Hosted Consent Pages API
Yapily Hosted Payment Pages API
Yapily Notifications API
Yapily User Beneficiaries API