Search Results

The Create Session endpoint accepts data about a customer's finances and lending scenario, which it stores in the database as a "session" and returns a SessionID parameter that can be used to load the data from that session in the Mortgage Recommendation Engin...

In the MRE, lenders are referenced in two places: Requesting which lenders should be used in calculation of results Assigning a lender to an existing loan or liability within the customer's financial data Supported lenders for calculation When re...

Overview For the first phase of integration between MyCRM and the Mortgage Recommendation Engine (MRE), it was decided to use the MRE's user interface for viewing results – instead of directly integrating the MRE API and rendering the results inside MyCRM's o...

The table below defines the list of accepted values within the Security.PropertyType parameter of the API request payload. This is a hierarchical list, allowing property types to be specified to up to three levels of granularity. This parameter is used to dete...

The Quote endpoint returns a list of quote results containing premiums that have been calculated based on details provided in the request. These details must include client demographics, chosen benefit options, and the providers and products they are intereste...

Returns a list of input parameters that are used when configuring the different benefits within the /quote calculation request. The returned input parameters are defined by their type (eg. dropdown list) and their accepted option values, and are grouped by the...

Returns a list of the insurance providers supported by the API, along with the benefits and products that they offer. This data will only change a few times per year, depending on any renaming or addition/removal of products by the insurers. Request Type...

The following insurance providers are available to be quoted via the Quote Engine.This information can be queried via a GET /providers request. Provider Name & ID Available Benefits Available Discounts     Accuro ProviderId: 1   ...

The following insurance benefits are available to be quoted via the Quote Engine: ID Benefit Description Optional Add-Ons 1 Health Cover Helps to cover the cost of the insured person's medical expenses. GP & Prescriptions Specialists & T...

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 N...

All requests to the Quote Engine are authenticated via an API key. If a request does not contain a valid key, the Quote Engine will return a 403 error. Requests must be sent over HTTPs. Request Headers Your userToken API key should be included in the heade...

This page details the response from the /quote calculation endpoint. See Quote Request for details about how to make a request to this endpoint. Response Success  200: Success Payload Structure The data in the Quote response payload is structured as f...

The table below details the history of updates made to the Quote Engine API: Prod Release Provider Benefits Description In testing nib Health Cover New rates for Health Cover nib are releasing their Q2 2024 rates for Ultimate Health, U...

The Generate Report endpoint accepts data about a customer's finances and lending scenario, along with lenders to calculate the report for. The endpoint may take a few seconds to generate a report which consists of a single loan amount case for each of the s...

The Export Report to PDF endpoint exports a generated mortgage report to PDF format and returns a downloadable PDF file URL. Request Type: POST Path: /engine/export-report-pdf Endpoint The Export Report to PDF endpoint can be accessed from the...