OpenAPI showcase

Criterion's OpenAPI definitions help to power the API economy

OpenAPI definitions are a set of guidelines and protocols that define how software components should interact with each other. These standards ensure consistency, compatibility, and interoperability between different systems and services, allowing them to communicate effectively and seamlessly exchange data. OpenAPI standards often include definitions for data formats, communication protocols, and error-handling procedures, facilitating the integration of diverse software applications and enabling the development of robust and scalable systems.

These OpenAPI definitions when implemented, reduce risk, cost, and friction to improve efficiency.

You can browse our OpenAPI definitions below, which have been produced in collaboration with the industry covering the following key markets:

MPS Standards;
Equity Release;
Letter of Authority (LoA);
Life, Pensions and Investments;
Group Risk.

Overview

History

Our API history stretches back over 20 years, since we first published our own HTTP Message Transmission Guidelines.

Initially, API specifications were often proprietary or ad hoc, meaning that each API provider had its own format for documenting APIs, making it challenging for developers to work with multiple APIs consistently.

At the time, we were ahead of the curve but technology and capability has evolved to streamline API development and consumption, fostering interoperability and simplifying the process of building and interacting with APIs, which led to the development of the OpenAPI Specification. Criterion has adopted this best-practice technology to produce OpenAPI definitions to provide solutions for a range of integration needs.

OpenAPI Specification

The OpenAPI Specification (formerly known as Swagger Specification) is a standard format used to describe APIs.

It is used to write individual OpenAPI definitions that define the endpoints, request parameters, response formats, authentication methods, and other details necessary for interacting with an API.

The definition is written in YAML or JSON format and serves as a contract between the API provider and users. It allows developers to understand how to interact with the API without needing to inspect its implementation details, promoting interoperability and simplifying the process of building client applications that integrate with the API.

OpenAPI definitions are often used for documenting APIs, generating libraries, and automating various aspects of API development and testing. They facilitate communication between different teams involved in API development, such as backend and frontend developers, and API users.

How we help the industry

Operating as a not-for-profit, Criterion collaborates with the industry as an independent third party to create Standards and improve efficiencies in the financial services sector.

We have been providing the backbone for the exchange and movement of data between organisations for almost 30 years.

In addition to driving efficiencies, we are uniquely positioned to facilitate and drive cross-industry engagement, helping organisations achieve higher levels of collaboration, reduce costs and achieve better customer outcomes.

Get in touch if you would like to know more about our OpenAPI Specifications. Contact us