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",
"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": "<br /> Additional percentage loading multiplier, 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.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": {
"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."
},
"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": "<br /> 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": "<br /> 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": "benefitId=1",
"required": [
"benefitId",
"benefitProducts"
],
"properties": {
"benefitId": {
"$ref": "#/$defs/Benefit.benefitId",
"description": "abc",
"const": 1
},
"clientBenefitId": {
"$ref": "#/$defs/Benefit.clientBenefitId"
},
"loading": {
"$ref": "#/$defs/Benefit.loading"
},
"benefitProducts": {
"$ref": "#/$defs/Benefit.benefitProducts"
},
"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",
"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(default value) <br />\r\n`true` – include GP & Prescriptions",
"nullable": true
},
"specialistsTest": {
"type": "boolean",
"description": "<br /> Toggle the optional Specialists & Tests benefit (under Health Cover) on and off : <br /><br />\r\n `false` – not included(default value) <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": "<br /> Toggle the optional Dental & Optical benefit (under Health Cover) on and off : <br /><br />\r\n `false` – not included(default value) <br />\r\n `true` – include Dental & Optical",
"default": false,
"nullable": true
}
}
},
{
"title": "2 – Life Cover",
"type": "object",
"description": "benefitId=2",
"required": [
"benefitId",
"benefitProducts",
"calcPeriod",
"coverAmount"
],
"properties": {
"benefitId": {
"$ref": "#/$defs/Benefit.benefitId",
"const": 1
},
"clientBenefitId": {
"$ref": "#/$defs/Benefit.clientBenefitId"
},
"loading": {
"$ref": "#/$defs/Benefit.loading"
},
"benefitProducts": {
"$ref": "#/$defs/Benefit.benefitProducts"
},
"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": "<br /> 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
},
"futureInsurability": {
"type": "boolean",
"description": "<br /> Toggle the optional Future Insurability benefit (under Life Cover) on and off : <br /><br />\r\n `false` – not included(default value) <br />\r\n `true` – include Future Insurability",
"default": false,
"nullable": true
},
"indexed": {
"type": "boolean",
"description": "<br /> Toggle CPI Indexation on and off: <br /><br /> \r\n `false` – no indexation <br /> \r\n `true` – apply CPI indexation",
"default": true
}
}
},
{
"title": "13 – HealthFamily Cover"Protection(Life Income)",
"type": "object",
"description": "benefitId=1"3",
"required": [
"benefitId",
"benefitProducts",
"benefitPeriod",
"benefitPeriodType",
"coverAmount"
],
"properties": {
"benefitId": {
"$ref": "#/$defs/Benefit.benefitId",
"const": 1
},
"clientBenefitId": {
"$ref": "#/$defs/Benefit.clientBenefitId"
},
"loading": {
"$ref": "#/$defs/Benefit.loading"
},
"benefitProducts": {
"$ref": "#/$defs/Benefit.benefitProducts"
},
"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": {
"type": "boolean",
"description": "<br /> Toggle CPI Indexation on and off: <br /><br /> \r\n `false` – no indexation <br /> \r\n `true` – apply CPI indexation",
"default": true
}
}
},
{
"title": "14 – HealthTrauma Cover",
"type": "object",
"description": "benefitId=1"4",
"required": [
"benefitId",
"benefitProducts",
"calcPeriod",
"coverAmount"
],
"properties": {
"benefitId": {
"type"$ref": "integer",
"description": "The id of the benefit to be quoted",
"format": "int32"#/$defs/Benefit.benefitId",
"const": 1
},
"clientBenefitId": {
"$ref": "#/$defs/Benefit.clientBenefitId"
},
"loading": {
"$ref": "#/$defs/Benefit.loading"
},
"benefitProducts": {
"$ref": "#/$defs/Benefit.benefitProducts"
},
"coverAmount": {
"type": "string"number",
"description": "OptionalAmount customof identifiercover provided/ bysum theinsured, requestor.in ThisNew Zealand Dollars (NZD). Value is returnedtreated withas: the<br result/>\r\n* in<b>Lump theSum</b> response."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",
"nullable"format": true"double"
},
"loading"calcPeriod": {
"type": "number",
"description": "<br /> AdditionalThe percentagepremium loadingreview multiplier,term for example:the benefit: <br /><br /> \r\n `1.0`1` – noYearly additional loadingRenewable <br /> \r\n `1.5`, `10`, `15` – 50%Level additionalfor loadingspecified number of years <br /> \r\n `2.0`50`, `60`, `65`, `70` etc – 100%Level additionalto loading"specified age",
"format": "double",
"default": 1
},
"benefitProducts"accelerated": {
"type": "array"boolean",
"items"description": {"<br "required":/> [Toggle "productId"acceleration on and off for Trauma or TPD: <br /><br />\r\n `false` – standalone(default value) <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 or TPDs",
"providerId"default": ]false,
"nullable": true
},
"type": "object",
"properties": {
"providerId"traumaBuyback": {
"type": "integer"boolean",
"description": "The<br id/> ofToggle the provideroptional whoseTrauma productBuyBack isbenefit being(under quoted."Trauma) on and off : <br /><br />\r\n `false` – not included(default value) <br />\r\n `true` – include Trauma BuyBack",
"format"default": false,
"int32"nullable": true
},
"productId"lifeBuyback": {
"type": "integer"boolean",
"description": "<br /> Toggle the optional Life BuyBack benefit (under Trauma) on and off : <br /><br />\r\n `false` – not included(default value) <br />\r\n `true` – include Life BuyBack 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 id`occupationType` property is required if including the TPD Add-On",
"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
},
"seriousTrauma": {
"type": "boolean",
"description": "<br /> Toggle the optional Serious Trauma benefit (under Trauma) on and off : <br /><br />\r\n `false` – not included(default value) <br />\r\n `true` – include Serious Trauma <br /><br />\r\n The `seriousTraumaCoverAmount` is required if including the Serious Trauma benefit",
"default": false,
"nullable": true
},
"seriousTraumaCoverAmount": {
"type": "number",
"description": "Amount of cover (in New Zealand Dollars) for the productoptional beingSerious quoted.Trauma benefit. <br />\r\nOnly required if `seriousTrauma = true`",
"format": "int32"double",
}"nullable": true
},
"additionalProperties"indexed": false{
}"type": "boolean",
"description": "An<br array/> ofToggle oneCPI orIndexation more Product objects containing the details of the providerson and productsoff: to<br be/><br quoted/> for\r\n the`false` current– beneft.no indexation <br /> \r\n `true` – apply CPI indexation",
"default": true
}
}
},
{
"title": "15 – HealthTotal Cover"& Permanent Disability",
"type": "object",
"description": "benefitId=1"5",
"required": [
"benefitId",
"benefitProducts",
"calcPeriod",
"coverAmount"
],
"properties": {
"benefitId": {
"type"$ref": "integer",
"description": "The id of the benefit to be quoted",
"format": "int32"#/$defs/Benefit.benefitId",
"const": 1
},
"clientBenefitId": {
"$ref": "#/$defs/Benefit.clientBenefitId"
},
"loading": {
"$ref": "#/$defs/Benefit.loading"
},
"benefitProducts": {
"$ref": "#/$defs/Benefit.benefitProducts"
},
"coverAmount": {
"type": "string"number",
"description": "OptionalAmount customof identifiercover provided/ bysum theinsured, requestor.in ThisNew Zealand Dollars (NZD). Value is returnedtreated withas: the<br result/>\r\n* in<b>Lump theSum</b> response."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",
"nullable"format": true"double"
},
"loading"calcPeriod": {
"type": "number",
"description": "<br /> AdditionalThe percentagepremium loadingreview multiplier,term for example:the benefit: <br /><br /> \r\n `1.0`1` – noYearly additional loadingRenewable <br /> \r\n `1.5`, `10`, `15` – 50%Level additionalfor loadingspecified number of years <br /> \r\n `2.0`50`, `60`, `65`, `70` etc – 100%Level additionalto loading"specified age",
"format": "double",
"default": 1
},
"benefitProducts"accelerated": {
"type": "array"boolean",
"items"description": "<br /> Toggle acceleration on and off for Trauma or TPD: <br /><br />\r\n `false` – standalone(default value) <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 or TPDs",
"default": false,
"nullable": true
},
"occupationType": {
"required"type": [
"productId"string",
"providerId"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": {
"type": "boolean",
"description": "<br /> Toggle CPI Indexation on and off: <br /><br /> \r\n `false` – no indexation <br /> \r\n `true` – apply CPI indexation",
"default": true
}
}
},
{
"title": "6 – Income Protection",
"type": "object",
"description": "benefitId=6",
"required": [
"benefitId",
"benefitProducts",
"benefitPeriod",
"benefitPeriodType",
"coverAmount",
"weekWaitPeriod"
],
"properties": {
"providerId"benefitId": {
"$ref": "#/$defs/Benefit.benefitId",
"const": 1
},
"clientBenefitId": {
"$ref": "#/$defs/Benefit.clientBenefitId"
},
"loading": {
"$ref": "#/$defs/Benefit.loading"
},
"benefitProducts": {
"$ref": "#/$defs/Benefit.benefitProducts"
},
"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": "TheSpecifies idthe period of time for which the providerbenefit whosewill productbe ispayable being– quoted.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"
},
"productId"benefitPeriodType": {
"type": "integer"string",
"description": "TheDefines idwhether 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 />"
},
"booster": {
"type": "boolean",
"description": "<br /> Toggle the productoptional beingBooster quoted.benefit (under Income Protection) on and off : <br /><br />\r\n `false` – not included(default value) <br />\r\n `true` – include Booster <br />",
"default": false,
"nullable": true
},
"weekWaitPeriod": {
"type": "number",
"description": "Specifies the number of weeks after which the benefit will start to be paid",
"format": "int32"
}double"
},
"additionalProperties"indexed": false{
}"type": "boolean",
"description": "An<br array/> ofToggle oneCPI orIndexation more Product objects containing the details of the providerson and productsoff: to<br be/><br quoted/> for\r\n the`false` current– beneft.no indexation <br /> \r\n `true` – apply CPI indexation",
"default": true
}
}
},
{
"title": "17 – HealthMortgage Repayment Cover",
"type": "object",
"description": "benefitId=1"7",
"required": [
"benefitId",
"benefitProducts",
"benefitPeriod",
"benefitPeriodType",
"coverAmount",
"weekWaitPeriod"
],
"properties": {
"benefitId": {
"type"$ref": "integer",
"description": "The id of the benefit to be quoted",
"format": "int32"#/$defs/Benefit.benefitId",
"const": 1
},
"clientBenefitId": {
"type"$ref": "string",
"description": "Optional custom identifier provided by the requestor. This is returned with the result in the response.",
"nullable": true#/$defs/Benefit.clientBenefitId"
},
"loading": {
"$ref": "#/$defs/Benefit.loading"
},
"benefitProducts": {
"$ref": "#/$defs/Benefit.benefitProducts"
},
"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 /> AdditionalSee percentage loading multiplier,`benefitPeriodType` for example: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": {
"type": "boolean",
"description": "<br /> Toggle CPI Indexation on and off: <br /><br /> \r\n `1.0`false` – no additional loadingindexation <br /> \r\n `1.5`true` – 50%apply additionalCPI loading <br /> \r\n `2.0` – 100% additional loading",
"format": "double"indexation",
"default": 1
},
"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."true
}
}
},
{
"title": "18 – HealthRedundancy Cover",
"type": "object",
"description": "benefitId=1"8",
"required": [
"benefitId",
"benefitProducts",
"coverAmount"
],
"properties": {
"benefitId": {
"type"$ref": "integer",
"description": "The id of the benefit to be quoted",
"format": "int32"#/$defs/Benefit.benefitId",
"const": 1
},
"clientBenefitId": {
"type"$ref": "string",
"description": "Optional custom identifier provided by the requestor. This is returned with the result in the response.",
"nullable": true#/$defs/Benefit.clientBenefitId"
},
"loading": {
"$ref": "#/$defs/Benefit.loading"
},
"benefitProducts": {
"$ref": "#/$defs/Benefit.benefitProducts"
},
"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": {
"type": "boolean",
"description": "<br /> AdditionalToggle percentageCPI loadingIndexation multiplier,on forand example:off: <br /><br /> \r\n `1.0`false` – no additional loadingindexation <br /> \r\n `1.5`true` – 50%apply additionalCPI loading <br /> \r\n `2.0` – 100% additional loading",
"format": "double"indexation",
"default": 1
},
"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."true
}
}
},
{
"title": "19 – HealthWaiver Cover"of Premium",
"type": "object",
"description": "benefitId=1"9",
"required": [
"benefitId",
"benefitProducts",
"weekWaitPeriod"
],
"properties": {
"benefitId": {
"type"$ref": "integer",
"description": "The id of the benefit to be quoted",
"format": "int32"#/$defs/Benefit.benefitId",
"const": 1
},
"clientBenefitId": {
"type"$ref": "string",
"description": "Optional custom identifier provided by the requestor. This is returned with the result in the response.",
"nullable": true#/$defs/Benefit.clientBenefitId"
},
"loading": {
"$ref": "#/$defs/Benefit.loading"
},
"benefitProducts": {
"$ref": "#/$defs/Benefit.benefitProducts"
},
"weekWaitPeriod": {
"type": "number",
"description": "<brSpecifies />the Additionalnumber percentageof loadingweeks multiplier,after forwhich example:the <brbenefit /><brwill />start \r\nto `1.0`be – no additional loading <br /> \r\n `1.5` – 50% additional loading <br /> \r\n `2.0` – 100% additional loading"paid",
"format": "double",
"default"nullable": 1
},
"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."true
}
}
},
{
"title": "110 – HealthSpecial Cover"Injury",
"type": "object",
"description": "benefitId=1"10",
"required": [
"benefitId",
"benefitProducts",
"coverAmount"
],
"properties": {
"benefitId": {
"type"$ref": "integer",
"description": "The id of the benefit to be quoted",
"format": "int32"#/$defs/Benefit.benefitId",
"const": 1
},
"clientBenefitId": {
"type"$ref": "string",
"description": "Optional custom identifier provided by the requestor. This is returned with the result in the response.",
"nullable": true#/$defs/Benefit.clientBenefitId"
},
"loading": {
"$ref": "#/$defs/Benefit.loading"
},
"benefitProducts": {
"$ref": "#/$defs/Benefit.benefitProducts"
},
"coverAmount": {
"type": "number",
"description": "<brAmount of cover /> Additionalsum percentageinsured, loadingin multiplier,New forZealand example:Dollars (NZD). Value is treated as: <br />\r\n* <brb>Lump Sum</b> \r\namount `1.0`for –Life, noTrauma, additional loadingTPD <br /> \r\nn* `1.5`<b>Annual</b> –cover 50%for additionalIncome loadingProtection <br /> \r\nn* `2.0`<b>Monthly</b> –amount/cover 100%for additionalFamily loading"Protection, Mortgage, Redundancy, Special Injury",
"format": "double",
"default": 1
},
"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."
}
}
},
{
"title": "1 – Health Cover",
"type": "object",
"description": "benefitId=1",
"required": [
"benefitId",
"benefitProducts"
],
"properties": {
"benefitId": {
"type": "integer",
"description": "The id of the benefit to be quoted",
"format": "int32",
"const": 1
},
"clientBenefitId": {
"type": "string",
"description": "Optional custom identifier provided by the requestor. This is returned with the result in the response.",
"nullable": true
},
"loading": {
"type": "number",
"description": "<br /> Additional percentage loading multiplier, 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
},
"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."
}
}
}
]
},
"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 below to see the relevant properties."
}
},
"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"
},
"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)"
}
},
"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
INSERT HERE
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
INSERT HERE
Examples
Error Response
{
"data": {
"response": {
"code": 0,
"message": "string"
}
}
}403: userToken is invalid or no longer valid