Quote
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 interested in. Each request generates a new quote. Quotes are not saved by the API.
Request
- Type:
POST - Path:
/quote - URL (Test env):
https://quote-engine-test.blackfin.tools/quote
Request payload is sent as HTTP JSON body.
Authentication
A security user token is required to authenticate the request source. BlackFin will generate this and provide it separately.
- Header parameter name:
userToken
JSON Schema
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$defs": {
"Benefit.benefitId": {
"type": "integer",
"description": "The id of the benefit to be quoted. See [supported benefits](https://docs.blackfin.tools/books/quoteengineapi/page/supported-benefits)",
"format": "int32"
},
"Benefit.clientBenefitId": {
"type": "string",
"description": "Optional custom identifier provided by the requestor. This is returned with the result in the response.",
"nullable": true
},
"Benefit.loading": {
"type": "number",
"description": "Optional loading multiplier for the current benefit, for example: <br /><br /> \r\n `1.0` – no additional loading <br /> \r\n `1.5` – 50% additional loading <br /> \r\n `2.0` – 100% additional loading",
"format": "double",
"default": 1
},
"Benefit.indexed": {
"type": "boolean",
"description": "Toggle CPI Indexation on and off for the current benefit: <br /><br /> \r\n `false` – no indexation <br /> \r\n `true` – apply CPI indexation",
"default": true
},
"Benefit.benefitProducts": {
"type": "array",
"items": {
"required": [
"productId",
"providerId"
],
"type": "object",
"properties": {
"providerId": {
"type": "integer",
"description": "The id of the provider whose product is being quoted.",
"format": "int32"
},
"productId": {
"type": "integer",
"description": "The id of the product being quoted.",
"format": "int32"
}
},
"additionalProperties": false
},
"description": "An array of one or more Product objects containing the details of the providers and products to be quoted for the current beneft."
}
},
"required": [
"clients",
"settings"
],
"type": "object",
"properties": {
"clients": {
"type": "array",
"items": {
"required": [
"age",
"clientBenefits",
"employedStatus",
"gender",
"occupationId",
"smoker"
],
"type": "object",
"properties": {
"firstName": {
"type": "string",
"description": "First name of the individual to be insured",
"nullable": true
},
"lastName": {
"type": "string",
"description": "Last name of the indivual to be insured",
"nullable": true
},
"age": {
"type": "integer",
"description": "Current age of the individual to be insured",
"format": "int32"
},
"gender": {
"type": "string",
"description": "Gender of the individual to be insured: <br /><br />\r\n`F` – Female <br />\r\n`M` – Male"
},
"smoker": {
"type": "boolean",
"description": "Indicates whether the individual to be insured is a smoker: <br /><br />\r\n`false` – Non-smoker <br />\r\n`true` – Smoker <br />"
},
"employedStatus": {
"type": "string",
"description": "The employment status of the individual to be insured: <br /><br />\r\n `Employed` <br />\r\n `Self-employed` <br />\r\n `Self-employed < 3 Years` <br />\r\n `Non-earner` <br /><br />\r\n This property is not required when quoting for Health Cover, Life Cover, Family Protection, and Trauma Cover",
"default": "Employed"
},
"occupationId": {
"type": "integer",
"description": "The occupation class of the individual to be insured: <br /><br />\r\n`1` – Class 1 <br />\r\n`2` – Class 2 <br />\r\n`3` – Class 3 <br />\r\n`4` – Class 4 <br />\r\n`5` – Class 5 <br /><br />\r\nThis property is not required when quoting for Health Cover, Life Cover, Family Protection, or Trauma Cover.",
"format": "int32"
},
"isChild": {
"type": "boolean",
"description": "Inidicates whether the individual to be insured is a child / dependent: <br /><br />\r\n `false` – adult <br />\r\n `true` – child / dependent",
"default": false
},
"clientId": {
"type": "string",
"description": "Optional custom identifier provided by the requestor. This is returned with the result in the response.",
"nullable": true
},
"clientBenefits": {
"type": "array",
"items": {
"anyOf": [
{
"title": "1 – Health Cover",
"description": "An array of one or more Benefit objects containing the details of the insurance benefit(s) to be quoted for the current client. Not all properties are relevant for every benefit. <br /><br />\r\nSelect each `benefitId` from the dropdown above to see the relevant properties.",
"required": [
"benefitId",
"benefitProducts"
],
"properties": {
"benefitId": {
"$ref": "#/$defs/Benefit.benefitId"
},
"clientBenefitId": {
"$ref": "#/$defs/Benefit.clientBenefitId"
},
"excess": {
"type": "integer",
"description": "Defines the excess amount (in NZD) payable by the client under Health Cover, for example: <br /><br />\r\n`0` – nil excess <br />\r\n`250` – $250 excess <br />\r\n`500` – $500 excess etc",
"format": "int32",
"default": 0,
"nullable": true
},
"gpPrescriptions": {
"type": "boolean",
"description": "Toggle the optional GP & Prescriptions benefit (under Health Cover) on and off : <br /><br />\r\n`false` – not included <br />\r\n`true` – include GP & Prescriptions",
"default": false,
"nullable": true
},
"specialistsTest": {
"type": "boolean",
"description": "Toggle the optional Specialists & Tests benefit (under Health Cover) on and off : <br /><br />\r\n `false` – not included <br />\r\n `true` – include Specialists & Tests",
"default": false,
"nullable": true
},
"specialistsTestExcess": {
"type": "integer",
"description": "Defines the excess amount (in NZD) payable by the client under the Specialists & Tests benefit, if applicable. For example: <br /><br />\r\n`0` – nil excess <br />\r\n`250` – $250 excess <br /><br />\r\nIf not provided, the primary `Excess` value will be used.",
"format": "int32",
"nullable": true
},
"dentalOptical": {
"type": "boolean",
"description": "Toggle the optional Dental & Optical benefit (under Health Cover) on and off : <br /><br />\r\n `false` – not included <br />\r\n `true` – include Dental & Optical",
"default": false,
"nullable": true
},
"loading": {
"$ref": "#/$defs/Benefit.loading"
},
"benefitProducts": {
"$ref": "#/$defs/Benefit.benefitProducts"
}
}
},
{
"title": "2 – Life Cover",
"type": "object",
"description": "An array of one or more Benefit objects containing the details of the insurance benefit(s) to be quoted for the current client. Not all properties are relevant for every benefit. <br /><br />\r\nSelect each `benefitId` from the dropdown above to see the relevant properties.",
"required": [
"benefitId",
"benefitProducts",
"calcPeriod",
"coverAmount"
],
"properties": {
"benefitId": {
"$ref": "#/$defs/Benefit.benefitId"
},
"clientBenefitId": {
"$ref": "#/$defs/Benefit.clientBenefitId"
},
"coverAmount": {
"type": "number",
"description": "Amount of cover / sum insured, in New Zealand Dollars (NZD). Value is treated as: <br />\r\n* <b>Lump Sum</b> amount for Life, Trauma, TPD <br />\r\n* <b>Annual</b> cover for Income Protection <br />\r\n* <b>Monthly</b> amount/cover for Family Protection, Mortgage, Redundancy, Special Injury",
"format": "double"
},
"calcPeriod": {
"type": "number",
"description": "The premium review term for the benefit: <br /><br />\r\n `1` – Yearly Renewable (Stepped) <br />\r\n `5`, `10`, `15` – Level for specified number of years <br />\r\n `50`, `60`, `65`, `70` etc – Level to specified age",
"format": "double",
"default": 1
},
"futureInsurability": {
"type": "boolean",
"description": "Toggle the optional Future Insurability benefit (under Life Cover) on and off : <br /><br />\r\n `false` – not included <br />\r\n `true` – include Future Insurability",
"default": false,
"nullable": true
},
"indexed": {
"$ref": "#/$defs/Benefit.indexed"
},
"loading": {
"$ref": "#/$defs/Benefit.loading"
},
"benefitProducts": {
"$ref": "#/$defs/Benefit.benefitProducts"
}
}
},
{
"title": "3 – Family Protection (Life Income)",
"type": "object",
"description": "An array of one or more Benefit objects containing the details of the insurance benefit(s) to be quoted for the current client. Not all properties are relevant for every benefit. <br /><br />\r\nSelect each `benefitId` from the dropdown above to see the relevant properties.",
"required": [
"benefitId",
"benefitProducts",
"benefitPeriod",
"benefitPeriodType",
"coverAmount"
],
"properties": {
"benefitId": {
"$ref": "#/$defs/Benefit.benefitId"
},
"clientBenefitId": {
"$ref": "#/$defs/Benefit.clientBenefitId"
},
"coverAmount": {
"type": "number",
"description": "Amount of cover / sum insured, in New Zealand Dollars (NZD). Value is treated as: <br />\r\n* <b>Lump Sum</b> amount for Life, Trauma, TPD <br />\r\n* <b>Annual</b> cover for Income Protection <br />\r\n* <b>Monthly</b> amount/cover for Family Protection, Mortgage, Redundancy, Special Injury",
"format": "double"
},
"benefitPeriod": {
"type": "integer",
"description": "Specifies the period of time for which the benefit will be payable – either as a specific number of years (eg. '5' years) or to a specific age (eg. age '65'). <br /><br /> See `benefitPeriodType` for definition.",
"format": "int32"
},
"benefitPeriodType": {
"type": "string",
"description": "Defines whether the `benefitPeriod` number is expressed as: <br /><br />\r\n`age` – to a specific age <br />\r\n`term` – a fixed term (specific number of years) <br />"
},
"indexed": {
"$ref": "#/$defs/Benefit.indexed"
},
"loading": {
"$ref": "#/$defs/Benefit.loading"
},
"benefitProducts": {
"$ref": "#/$defs/Benefit.benefitProducts"
}
}
},
{
"title": "4 – Trauma Cover",
"type": "object",
"description": "An array of one or more Benefit objects containing the details of the insurance benefit(s) to be quoted for the current client. Not all properties are relevant for every benefit. <br /><br />\r\nSelect each `benefitId` from the dropdown above to see the relevant properties.",
"required": [
"benefitId",
"benefitProducts",
"calcPeriod",
"coverAmount"
],
"properties": {
"benefitId": {
"$ref": "#/$defs/Benefit.benefitId"
},
"clientBenefitId": {
"$ref": "#/$defs/Benefit.clientBenefitId"
},
"coverAmount": {
"type": "number",
"description": "Amount of cover / sum insured, in New Zealand Dollars (NZD). Value is treated as: <br />\r\n* <b>Lump Sum</b> amount for Life, Trauma, TPD <br />\r\n* <b>Annual</b> cover for Income Protection <br />\r\n* <b>Monthly</b> amount/cover for Family Protection, Mortgage, Redundancy, Special Injury",
"format": "double"
},
"calcPeriod": {
"type": "number",
"description": "The premium review term for the benefit: <br /><br />\r\n `1` – Yearly Renewable (Stepped) <br />\r\n `5`, `10`, `15` – Level for specified number of years <br />\r\n `50`, `60`, `65`, `70` etc – Level to specified age",
"format": "double",
"default": 1
},
"accelerated": {
"type": "boolean",
"description": "Toggle acceleration on and off for Trauma Cover: <br /><br />\r\n `false` – standalone <br />\r\n `true` – accelerated <br /><br />\r\n Quote must also include a Life Cover benefit for the same client, in order to accelerate the Trauma Cover",
"default": false,
"nullable": true
},
"traumaBuyback": {
"type": "boolean",
"description": "Toggle the optional Trauma BuyBack benefit (under Trauma) on and off : <br /><br />\r\n `false` – not included <br />\r\n `true` – include Trauma BuyBack",
"default": false,
"nullable": true
},
"traumaBuybackType": {
"type": "string",
"description": "Defines the type of Trauma Buyback benefit to be quoted. Not all providers offer both options: <br /><br />\r\n `deferred` – cover continues after a stand-down period (usually 12 months) following a claim <br />\r\n`instant` – cover continues immediately following a claim <br /><br />\r\n This setting is ignored unless `traumaBuyback = true`",
"default": "deferred",
"nullable": true
},
"lifeBuyback": {
"type": "boolean",
"description": "Toggle the optional Life BuyBack benefit (under Accelerated Trauma) on and off : <br /><br />\r\n `false` – not included <br />\r\n `true` – include Life BuyBack <br /> <br />\r\n Only applicable if `accelerated = true`",
"default": false,
"nullable": true
},
"tpdAddon": {
"type": "boolean",
"description": "<br /> Toggle the optional TPD Add-On benefit (under Trauma) on and off : <br /><br />\r\n `false` – not included(default value) <br />\r\n `true` – include TPD Add-On <br /><br />\r\n The `occupationType` property is required if including the TPD Add-On (see below)",
"default": false,
"nullable": true
},
"occupationType": {
"type": "string",
"description": "Defines whether the TPD Add-On benefit covers the individual's inability to work in their current (own) occupation: <br /><br />\r\n`own` – own occupation <br />\r\n`any` – any occupation <br /><br />\r\n This setting is only required if `tpdAddon = true`",
"nullable": true
},
"seriousTrauma": {
"type": "boolean",
"description": "Toggle the optional Serious Trauma benefit (under Trauma) on and off : <br /><br />\r\n `false` – not included <br />\r\n `true` – include Serious Trauma <br /><br />\r\n The `seriousTraumaCoverAmount` is required if including the Serious Trauma benefit (see below)",
"default": false,
"nullable": true
},
"seriousTraumaCoverAmount": {
"type": "number",
"description": "Amount of cover (in New Zealand Dollars) for the optional Serious Trauma benefit. <br />\r\nOnly required if `seriousTrauma = true`",
"format": "double",
"nullable": true
},
"indexed": {
"$ref": "#/$defs/Benefit.indexed"
},
"loading": {
"$ref": "#/$defs/Benefit.loading"
},
"benefitProducts": {
"$ref": "#/$defs/Benefit.benefitProducts"
}
}
},
{
"title": "5 – Total & Permanent Disability",
"type": "object",
"description": "An array of one or more Benefit objects containing the details of the insurance benefit(s) to be quoted for the current client. Not all properties are relevant for every benefit. <br /><br />\r\nSelect each `benefitId` from the dropdown above to see the relevant properties.",
"required": [
"benefitId",
"benefitProducts",
"calcPeriod",
"coverAmount",
"occupationType"
],
"properties": {
"benefitId": {
"$ref": "#/$defs/Benefit.benefitId"
},
"clientBenefitId": {
"$ref": "#/$defs/Benefit.clientBenefitId"
},
"coverAmount": {
"type": "number",
"description": "Amount of cover / sum insured, in New Zealand Dollars (NZD). Value is treated as: <br />\r\n* <b>Lump Sum</b> amount for Life, Trauma, TPD <br />\r\n* <b>Annual</b> cover for Income Protection <br />\r\n* <b>Monthly</b> amount/cover for Family Protection, Mortgage, Redundancy, Special Injury",
"format": "double"
},
"calcPeriod": {
"type": "number",
"description": "The premium review term for the benefit: <br /><br />\r\n `1` – Yearly Renewable <br />\r\n `5`, `10`, `15` – Level for specified number of years <br />\r\n `50`, `60`, `65`, `70` etc – Level to specified age",
"format": "double",
"default": 1
},
"accelerated": {
"type": "boolean",
"description": "Toggle acceleration on and off for TPD: <br /><br />\r\n `false` – standalone <br />\r\n `true` – accelerated <br /><br />\r\n Quote must also include a Life Cover benefit for the same client, in order to accelerate the TPD",
"default": false,
"nullable": true
},
"occupationType": {
"type": "string",
"description": "Defines whether the TPD benefit covers the individual's inability to work in their current (own) occupation: <br /><br />\r\n`own` – own occupation <br />\r\n`any` – any occupation <br />",
"nullable": true
},
"indexed": {
"$ref": "#/$defs/Benefit.indexed"
},
"loading": {
"$ref": "#/$defs/Benefit.loading"
},
"benefitProducts": {
"$ref": "#/$defs/Benefit.benefitProducts"
}
}
},
{
"title": "6 – Income Protection",
"type": "object",
"description": "An array of one or more Benefit objects containing the details of the insurance benefit(s) to be quoted for the current client. Not all properties are relevant for every benefit. <br /><br />\r\nSelect each `benefitId` from the dropdown above to see the relevant properties.",
"required": [
"benefitId",
"benefitProducts",
"benefitPeriod",
"benefitPeriodType",
"coverAmount",
"weekWaitPeriod"
],
"properties": {
"benefitId": {
"$ref": "#/$defs/Benefit.benefitId"
},
"clientBenefitId": {
"$ref": "#/$defs/Benefit.clientBenefitId"
},
"coverAmount": {
"type": "number",
"description": "Amount of cover / sum insured, in New Zealand Dollars (NZD). Value is treated as: <br />\r\n* <b>Lump Sum</b> amount for Life, Trauma, TPD <br />\r\n* <b>Annual</b> cover for Income Protection <br />\r\n* <b>Monthly</b> amount/cover for Family Protection, Mortgage, Redundancy, Special Injury",
"format": "double"
},
"benefitPeriod": {
"type": "integer",
"description": "Specifies the period of time for which the benefit will be payable – either as a specific number of years (eg. '5' years) or to a specific age (eg. age '65'). <br /><br /> See `benefitPeriodType` for definition.",
"format": "int32"
},
"benefitPeriodType": {
"type": "string",
"description": "Defines whether the `benefitPeriod` number is expressed as: <br /><br />\r\n`age` – to a specific age <br />\r\n`term` – a fixed term (specific number of years) <br />"
},
"weekWaitPeriod": {
"type": "number",
"description": "Specifies the number of weeks after which the benefit will start to be paid",
"format": "double"
},
"booster": {
"type": "boolean",
"description": "Toggle the optional Booster benefit (under Income Protection) on and off : <br /><br />\r\n `false` – not included <br />\r\n `true` – include Booster <br />",
"default": false,
"nullable": true
},
"indexed": {
"$ref": "#/$defs/Benefit.indexed"
},
"loading": {
"$ref": "#/$defs/Benefit.loading"
},
"benefitProducts": {
"$ref": "#/$defs/Benefit.benefitProducts"
}
}
},
{
"title": "7 – Mortgage Repayment Cover",
"type": "object",
"description": "An array of one or more Benefit objects containing the details of the insurance benefit(s) to be quoted for the current client. Not all properties are relevant for every benefit. <br /><br />\r\nSelect each `benefitId` from the dropdown above to see the relevant properties.",
"required": [
"benefitId",
"benefitProducts",
"benefitPeriod",
"benefitPeriodType",
"coverAmount",
"weekWaitPeriod"
],
"properties": {
"benefitId": {
"$ref": "#/$defs/Benefit.benefitId"
},
"clientBenefitId": {
"$ref": "#/$defs/Benefit.clientBenefitId"
},
"coverAmount": {
"type": "number",
"description": "Amount of cover / sum insured, in New Zealand Dollars (NZD). Value is treated as: <br />\r\n* <b>Lump Sum</b> amount for Life, Trauma, TPD <br />\r\n* <b>Annual</b> cover for Income Protection <br />\r\n* <b>Monthly</b> amount/cover for Family Protection, Mortgage, Redundancy, Special Injury",
"format": "double"
},
"benefitPeriod": {
"type": "integer",
"description": "Specifies the period of time for which the benefit will be payable – either as a specific number of years (eg. '5' years) or to a specific age (eg. age '65'). <br /><br /> See `benefitPeriodType` for definition.",
"format": "int32"
},
"benefitPeriodType": {
"type": "string",
"description": "Defines whether the `benefitPeriod` number is expressed as: <br /><br />\r\n`age` – to a specific age <br />\r\n`term` – a fixed term (specific number of years) <br />"
},
"weekWaitPeriod": {
"type": "number",
"description": "Specifies the number of weeks after which the benefit will start to be paid",
"format": "double"
},
"indexed": {
"$ref": "#/$defs/Benefit.indexed"
},
"loading": {
"$ref": "#/$defs/Benefit.loading"
},
"benefitProducts": {
"$ref": "#/$defs/Benefit.benefitProducts"
}
}
},
{
"title": "8 – Redundancy Cover",
"type": "object",
"description": "An array of one or more Benefit objects containing the details of the insurance benefit(s) to be quoted for the current client. Not all properties are relevant for every benefit. <br /><br />\r\nSelect each `benefitId` from the dropdown above to see the relevant properties.",
"required": [
"benefitId",
"benefitProducts",
"coverAmount"
],
"properties": {
"benefitId": {
"$ref": "#/$defs/Benefit.benefitId"
},
"clientBenefitId": {
"$ref": "#/$defs/Benefit.clientBenefitId"
},
"coverAmount": {
"type": "number",
"description": "Amount of cover / sum insured, in New Zealand Dollars (NZD). Value is treated as: <br />\r\n* <b>Lump Sum</b> amount for Life, Trauma, TPD <br />\r\n* <b>Annual</b> cover for Income Protection <br />\r\n* <b>Monthly</b> amount/cover for Family Protection, Mortgage, Redundancy, Special Injury",
"format": "double"
},
"indexed": {
"$ref": "#/$defs/Benefit.indexed"
},
"loading": {
"$ref": "#/$defs/Benefit.loading"
},
"benefitProducts": {
"$ref": "#/$defs/Benefit.benefitProducts"
}
}
},
{
"title": "9 – Waiver of Premium",
"type": "object",
"description": "An array of one or more Benefit objects containing the details of the insurance benefit(s) to be quoted for the current client. Not all properties are relevant for every benefit. <br /><br />\r\nSelect each `benefitId` from the dropdown above to see the relevant properties.",
"required": [
"benefitId",
"benefitProducts",
"weekWaitPeriod"
],
"properties": {
"benefitId": {
"$ref": "#/$defs/Benefit.benefitId"
},
"clientBenefitId": {
"$ref": "#/$defs/Benefit.clientBenefitId"
},
"weekWaitPeriod": {
"type": "number",
"description": "Specifies the number of weeks after which the benefit will start to be paid",
"format": "double",
"nullable": true
},
"loading": {
"$ref": "#/$defs/Benefit.loading"
},
"benefitProducts": {
"$ref": "#/$defs/Benefit.benefitProducts"
}
}
},
{
"title": "10 – Special Injury",
"type": "object",
"description": "An array of one or more Benefit objects containing the details of the insurance benefit(s) to be quoted for the current client. Not all properties are relevant for every benefit. <br /><br />\r\nSelect each `benefitId` from the dropdown above to see the relevant properties.",
"required": [
"benefitId",
"benefitProducts",
"coverAmount"
],
"properties": {
"benefitId": {
"$ref": "#/$defs/Benefit.benefitId"
},
"clientBenefitId": {
"$ref": "#/$defs/Benefit.clientBenefitId"
},
"coverAmount": {
"type": "number",
"description": "Amount of cover / sum insured, in New Zealand Dollars (NZD). Value is treated as: <br />\r\n* <b>Lump Sum</b> amount for Life, Trauma, TPD <br />\r\n* <b>Annual</b> cover for Income Protection <br />\r\n* <b>Monthly</b> amount/cover for Family Protection, Mortgage, Redundancy, Special Injury",
"format": "double"
},
"loading": {
"$ref": "#/$defs/Benefit.loading"
},
"benefitProducts": {
"$ref": "#/$defs/Benefit.benefitProducts"
}
}
}
]
}
},
"clientProviderSettings": {
"type": "array",
"description": "Optional array of provider-specific settings to be applied to the current client.",
"nullable": true,
"items": {
"required": [
"providerId"
],
"type": "object",
"properties": {
"providerId": {
"type": "integer",
"description": "The id of the provider for which settings are being applied. <br /><br />\r\nNote: at the current time, only the provider Chubb Life (id=8) has any applicable settings here.",
"format": "int32"
},
"lifetimeRewardSelected": {
"type": "boolean",
"description": "Toggle the Chubb Life 'Lifetime Reward' discount on and off for the current client. Eligible clients receive a lifetime discount on certain benefits: <br /><br />\r\n`false` – client not eligible for Lifetime Reward <br />\r\n`true` – client is eligible for Lifetime Reward",
"default": false,
"nullable": true
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
},
"description": "An array of Client objects containing the details of the individuals to be insured"
},
"settings": {
"required": [
"paymentFrequency"
],
"type": "object",
"properties": {
"paymentFrequency": {
"type": "integer",
"description": "The desired frequency for premium payments: <br /><br />\r\n`1` – Annually <br />\r\n`12` – Monthly <br />\r\n`26` – Fortnightly",
"format": "int32"
},
"calcDate": {
"type": "string",
"description": "Optional parameter that can be used to request calculation of premiums for a certain date (eg. historical or upcoming)",
"format": "YYYY-MM-DD",
"default": "{currentDate}",
"nullable": true
},
"providerSettings": {
"type": "array",
"items": {
"required": [
"providerId"
],
"type": "object",
"properties": {
"providerId": {
"type": "integer",
"description": "The id of the provider for which settings are being applied. <br /><br />\r\nNote: at the current time, only the provider AIA (id=11) has any applicable settings here.",
"format": "int32"
},
"vitalityDiscountSelected": {
"type": "boolean",
"description": "Toggle the AIA Vitality scheme membership on and off for all clients. Members of AIA's Vitality scheme receive a discount on their insurance premium: <br /><br />\r\n`false` – clients do not wish to join AIA Vitality <br />\r\n`true` – clients wish to join (or are already members of) AIA Vitality <br /><br />\r\n See related `vitalityFeeSelected` property below",
"default": false,
"nullable": true
},
"vitalityFeeSelected": {
"type": "boolean",
"description": "Toggle the applicability of the AIA Vitality fee, based on whether the client(s) are already members of the scheme: <br /><br />\r\n`false` – clients are already paying AIA Vitality fee(existing members) <br />\r\n`true` – clients are not existing Vitality members, therefore the fee is applicable",
"nullable": true
}
},
"additionalProperties": false
},
"description": "An optional array of provider-specific settings. <br /><br />\r\nNot all providers have applicable settings(see below) however this may change in future.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Quote Settings object. The settings entered here will be defined to the overall quote (ie. all clients and benefits)"
},
"comboQuoteId": {
"type": "string",
"nullable": true,
"description": "Optional user-provided ID to indicate that the request is one of multiple requests sent to calculate a 'Combo Quote', allowing BlackFin to group these requests together for analytics purposes."
}
},
"additionalProperties": false
}Examples
JSON Request Body
{
"comboQuoteId": "string",
"clients": [
{
"firstName": "string",
"lastName": "string",
"age": 0,
"gender": "string",
"smoker": true,
"employedStatus": "Employed",
"occupationId": 0,
"isChild": false,
"clientId": "string",
"clientBenefits": [
{
"clientBenefitId": "string",
"benefitId": 0,
"loading": 1,
"benefitProducts": [
{
"providerId": 0,
"productId": 0
}
]
}
]
}
],
"settings": {
"paymentFrequency": 0,
"providerSettings": [
{
"providerId": 0,
"vitalityDiscountSelected": false,
"vitalityFeeSelected": true
}
]
}
}
Response
Success
200: Success
JSON Schema
{
"type": "object",
"properties": {
"results": {
"type": "array",
"items": {
"type": "object",
"properties": {
"providerId": {
"type": "integer",
"description": "The ID of the provider for the current result.",
"format": "int32"
},
"providerName": {
"type": "string",
"description": "The name of the provider for the current result.",
"nullable": true
},
"providerLogoUrl": {
"type": "string",
"description": "The URL of the provider's logo image (hosted by BlackFin) that can be displayed with the result if desired.",
"nullable": true
},
"hexColor": {
"type": "string",
"description": "A hex color value representing the dominant colour from the provider's logo that can be incorporated into the design of the displayed result if desired.",
"nullable": true
},
"hasErrors": {
"type": "boolean",
"description": "Identifies whether the result is fully formed or whether there are errors within some products in the result. <br /><br />\r\n`false` – premiums have been successfully calculated for all products <br />\r\n`true` – at least one product contain errors <br /><br />\r\nIf `true` there will be at least one `error` message included within the products below."
},
"policyFee": {
"type": "number",
"description": "The amount of the applicable Policy Fee in New Zealand Dollars [NZD]",
"format": "double"
},
"vitalityFee": {
"type": "number",
"description": "The amount of the Vitality Fee (AIA only) in New Zealand Dollars [NZD], if applicable.",
"format": "double",
"nullable": true
},
"totalPremium": {
"type": "number",
"description": "The sum total of all individual product premiums (for all clients) in the current result - plus any applicable fees - in New Zealand Dollars [NZD].",
"format": "double"
},
"clients": {
"type": "array",
"items": {
"type": "object",
"properties": {
"clientId": {
"type": "string",
"description": "Returns the optional 'clientId' from the request, if one was provided by the requestor.",
"nullable": true
},
"clientName": {
"type": "string",
"description": "The fullname of the client for whom products have been quoted in the result. <br /><br />\r\nIf no `firstName` and/or `lastName` were provided by the requestor, the API will return an auto-generated name like \"Client 1\"",
"nullable": true
},
"products": {
"type": "array",
"items": {
"type": "object",
"properties": {
"clientBenefitId": {
"type": "string",
"description": "Returns the optional 'clientBenefitId' from the request, if one was provided by the requestor.",
"nullable": true
},
"benefitId": {
"type": "integer",
"description": "The ID of the benefit that has been quoted.",
"format": "int32"
},
"productId": {
"type": "integer",
"description": "The ID of the product that has been quoted.",
"format": "int32"
},
"productName": {
"type": "string",
"description": "The display name of the product that has been quoted.",
"nullable": true
},
"descriptions": {
"type": "array",
"items": {
"type": "string"
},
"description": "An optional array of strings containing additional descriptions about this product result – for example, any discounts that have been applied.",
"nullable": true
},
"premium": {
"type": "number",
"description": "The calculated premium amount for the current product (under the current client) in New Zealand Dollars [NZD].",
"format": "double"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Internal ID reference (from BlackFin) for the current error.",
"format": "int32"
},
"message": {
"type": "string",
"description": "The description of the error that was encountered. This is a human-friendly message that can be displayed to the user. For example: <br /><br /><i>\"TPD Add-on is not available for your occupation class\"</i>",
"nullable": true
}
},
"additionalProperties": false
},
"description": "An array of one or more objects detailing any errors encountered whilst failing to calculate a premium for the current product.",
"nullable": true
}
},
"additionalProperties": false
},
"description": "An array of one or more product objects that have been quoted for the current client in the result.",
"nullable": true
}
},
"additionalProperties": false
},
"description": "An array of one or more client objects for whom products have been quoted in the current result.",
"nullable": true
}
},
"additionalProperties": false
},
"description": "An array of quote result objects – one for every provider quoted. Each object contains the details needed to render the provider's result in a UI.",
"nullable": true
},
"quoteId": {
"type": "string",
"description": "The ID of the current quote, auto-generated by the API"
},
"paymentFrequency": {
"type": "string",
"description": "The display name of the chosen payment frequency. The possible values are:\r\n\r\n`Yearly` <br />\r\n`Monthly` <br />\r\n`Fortnightly`",
"nullable": true
},
"calcTime": {
"type": "number",
"description": "The amount of time taken by the API (in seconds) to calculate all premiums in the results.",
"format": "double"
},
"apiVersion": {
"type": "string",
"description": "API version / last update information",
"nullable": true
}
},
"additionalProperties": false
}Examples
Success Response
{
"results": [
{
"providerId": 0,
"providerName": "string",
"providerLogoUrl": "string",
"hexColor": "string",
"hasErrors": true,
"policyFee": 0,
"vitalityFee": 0,
"totalPremium": 0,
"clients": [
{
"clientId": "string",
"clientName": "string",
"products": [
{
"clientBenefitId": "string",
"benefitId": 0,
"productId": 0,
"productName": "string",
"descriptions": [
"string"
],
"premium": 0,
"errors": [
{
"id": 0,
"message": "string"
}
]
}
]
}
]
}
],
"quoteId": "string",
"paymentFrequency": "string",
"calcTime": 0,
"apiVersion": "string"
}Error
400: Request body is null or invalid
JSON Schema
{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32"
},
"message": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}Examples
Error Response
{
"data": {
"response": {
"code": 0,
"message": "string"
}
}
}403: userToken is invalid or no longer valid