API showcase

An overview of our suite of OpenAPI Specifications.

Application Programming Interface (API) specifications 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. API standards often include specifications for data formats, communication protocols, authentication methods, and error-handling procedures, facilitating the integration of diverse software applications and enabling the development of robust and scalable systems.

These API specifications when implemented, reduce risk, cost, and friction to improve efficiency.

You can browse our OpenAPI Specifications 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 OpenAPI specifications. 

OpenAPI Specification

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

It's a machine-readable document that defines the endpoints, request parameters, response formats, authentication methods, and other details necessary for interacting with an API.

The specification 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 Specifications 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

MPS OpenAPI Specification Standards

We have produced API Standards for key MPS processes to reduce risk, cost, and friction to improve efficiency.

MPS Edit Model and Rebalance OpenAPI Specification

74.56 KB

OpenAPI Specification for MPS Edit Model and Rebalance.

MPS MI OpenAPI Specification

96 KB

OpenAPI Specification for MPS Management Information (MI).

Equity Release OpenAPI Specification Standards

We have produced API Standards for key Equity Release processes and these are free to access and adopt.

Equity Release Quotes and KFI OpenAPI Specification

148.18 KB

OpenAPI Specification for Equity Release Quotes and KFI.

Equity Release Apply OpenAPI Specification

27.84 KB

OpenAPI Specification for Equity Release Apply.

LoA OpenAPI Specification Standards

We have produced API Standards for key LoA processes to support advisers onboarding new clients by providing effective and automated methods of gathering information.

LoA Fulfilment DC Pensions OpenAPI Specification

106.54 KB

OpenAPI Specification for LoA Fulfilment DC Pensions.

LoA Fulfilment Investments OpenAPI Specification

91.46 KB

OpenAPI Specification for LoA Fulfilment Investments.

LoA Fulfilment Wraps OpenAPI Specification

38.06 KB

OpenAPI Specification for LoA Fulfilment Wraps.

LoA Request OpenAPI Specification

37.47 KB

OpenAPI Specification for LoA Request.

Advice Charges Compenent OpenAPI Specification

35.86 KB

OpenAPI Specification for Advice Charges compenent.

Asset Holdings Component OpenAPI Specification

36.66 KB

OpenAPI Specification for Asset Holdings component.

Fund Charges Component OpenAPI Specification

37.11 KB

OpenAPI Specification for Fund Charges component.

Money In Component OpenAPI Specification

30.85 KB

OpenAPI Specification for Money In component.

Money Out Component OpenAPI Specification

29.68 KB

OpenAPI Specification for Money Out component.

Product Charges Component OpenAPI Specification

56.45 KB

OpenAPI Specification for Product Charges component.

Life, pension and investment OpenAPI Specification Standards

We have produced several API Standards for the life, pension and investment industry.

Retrieve Documentation OpenAPI Specification

23 KB

OpenAPI Specification for Retrieve Documentation.

Provide ISRN OpenAPI Specification

98.83 KB

OpenAPI Specification for Provide Investment Switch and Redirect Notification (ISRN).

Receive External Alert OpenAPI Specification

31.86 KB

OpenAPI Specification for Receive External Alert.

Remuneration Statement OpenAPI Specification

118.92 KB

OpenAPI Specification for Remuneration Statement.

Contract Enquiry Wrap Valuation OpenAPI Specification

168.67 KB

OpenAPI Specification for Contract Enquiry Wrap Valuation.

Group Risk OpenAPI Specification Standards

We have produced several API Standards for Group Risk to faciliate integration and automation for end-to-end processes.

GRQ GLA OpenAPI Specification

196.02 KB

OpenAPI Specification for Group Risk Quotes (GRQ) for Group Life Assurance (GLA).

Mid Term Accounting OpenAPI Specification

158.81 KB

OpenAPI Specification for Mid Term Accounting.