Skip to main content

Introduction

Developed by BlackFin Technology Pte Ltd in partnership with the New Zealand Financial Services Group (NZFSG), the “Quote Engine” API provides efficient and accurate premium calculation/comparison for personal risk and health insurance products from seven of New Zealand’s insurance providers.

API Reference

The Quote Engine API is a RESTful web service where requests are made over HTTPS using the GET and POST methods. Payloads use JSON format object schemas.

The API is comprised of three endpoints:

  • Quote Setup
    • GET Providers – returns a list of the insurance providers supported by the Quote Engine, along with the benefits and products that they offer. The object IDs used in this data-set are essential for making a quote calculation request.
    • GET QuoteConfig – returns a list of input parameters and accepted option values for each of the benefits supported by the Quote Engine. This config data may be useful for rendering interfaces for data capture during the quote setup stage.
  • Calculation
    • POST Quote – the main calculation endpoint, this returns a set of calculated insurance premiums based on the details of the clients, their chosen benefits, and the providers and products that were included in the request.

Environments

The Quote Engine API is provisioned in two environments with the following root URLs:

Both environments are available 24/7.

Back to top