Getting Started

The Aviva API Developer Portal offers our Partner developers the ability to integrate Aviva APIs directly into their own systems. The portal provides the capability to:

• Search and review all Aviva APIs, through our catalogue and extensive range of documentation and guides.
• Test each API through our Mock environments, where you can simulate a variety of authenticated inputs and review associated responses
• Request to Consume an API as part of a production environment

This guide provides an overview of the entire process, and the following diagram explains the overall implementation of the Aviva API architecture that encompasses the Aviva API Developer Portal

Only authorised Aviva Partners may create an account through our self-registration process.

• Without an account you can only view general information on Aviva APIs.
• With an account you can view detailed documentation & guides, test APIs and also request to consume our APIs in your environment.

The Aviva portal provides an extensive range of resources to help you Discover and understand our APIs.

• Review our APIs through accessing relevant categories from the Home Page menu here, or the Catalogue here. The catalogue provides a comprehensive search facility through free form text, API category and also API capability selection.
• All of our APIs are well described with an overview and details of key features and what the APIs can offer to your business.
• All Aviva APIs conform to Open API Standards v3.0.

Through our Access API page, you can examine each API in technical detail. Our Developer Implementation Guide here provides an illustrated step by step guide on how to use our Access API page in detail, covering:

• Access to API method calls
• Parameter settings
• Integration to testing within our Mock environment
• Request / Response schemas
• Authentication options
• Sample code to assist in building your API call invocations

Having discovered and reviewed an API you will have all the information you need for that API. If you wish to consume the API in a production environment, you will need to provide subscription information about your proposed usage of the API in our Consume API page here. The information provided will be assessed by Aviva and once formally agreed, we will configure your access to our API gateway for that API and you will receive all necessary credentials for access.