httpsEngineCreateSession
Creates a new session from provided data.
When successful, returns a SessionID which can be used to load that session in the MRE UI.
Function performs basic validation on the structure of the request payload but does not impose strict rules based on what is required for generating a report. This means, that a successfully created session does not guarantee the data is complete for actual calculation in the UI. Data is loaded on a best-effort basis in the UI and then user is required to fill in the missing bits if needed.
Request
Type: POST
Path: /httpsEngineCreateSession
URL (development): https://us-central1-mortgage-rec-engine-dev-msec.cloudfunctions.net/httpsEngineCreateSession
Request payload is sent as HTTP JSON body.
Authentication
API Key required. HTTP Bearer Token authentication is used.
JSON Payload
{
"$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"
},
"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": "3 – Family Protection(Life Income)",
"type": "object",
"description": "benefitId=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": "4 – Trauma Cover",
"type": "object",
"description": "benefitId=4",
"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
},
"accelerated": {
"type": "boolean",
"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
},
"traumaBuyback": {
"type": "boolean",
"description": "<br /> Toggle the optional Trauma BuyBack benefit (under Trauma) on and off : <br /><br />\r\n `false` – not included(default value) <br />\r\n `true` – include Trauma BuyBack",
"default": false,
"nullable": true
},
"lifeBuyback": {
"type": "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 `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 optional Serious Trauma benefit. <br />\r\nOnly required if `seriousTrauma = true`",
"format": "double",
"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": "5 – Total & Permanent Disability",
"type": "object",
"description": "benefitId=5",
"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
},
"accelerated": {
"type": "boolean",
"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": {
"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": {
"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": {
"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 />"
},
"booster": {
"type": "boolean",
"description": "<br /> Toggle the optional Booster 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": "double"
},
"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": "7 – Mortgage Repayment Cover",
"type": "object",
"description": "benefitId=7",
"required": [
"benefitId",
"benefitProducts",
"benefitPeriod",
"benefitPeriodType",
"coverAmount",
"weekWaitPeriod"
],
"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 />"
},
"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 `false` – no indexation <br /> \r\n `true` – apply CPI indexation",
"default": true
}
}
},
{
"title": "8 – Redundancy Cover",
"type": "object",
"description": "benefitId=8",
"required": [
"benefitId",
"benefitProducts",
"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"
},
"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": "9 – Waiver of Premium",
"type": "object",
"description": "benefitId=9",
"required": [
"benefitId",
"benefitProducts",
"weekWaitPeriod"
],
"properties": {
"benefitId": {
"$ref": "#/$defs/Benefit.benefitId",
"const": 1
},
"clientBenefitId": {
"$ref": "#/$defs/Benefit.clientBenefitId"
},
"loading": {
"$ref": "#/$defs/Benefit.loading"
},
"benefitProducts": {
"$ref": "#/$defs/Benefit.benefitProducts"
},
"weekWaitPeriod": {
"type": "number",
"description": "Specifies the number of weeks after which the benefit will start to be paid",
"format": "double",
"nullable": true
}
}
},
{
"title": "10 – Special Injury",
"type": "object",
"description": "benefitId=10",
"required": [
"benefitId",
"benefitProducts",
"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"
}
}
}
]
},
"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
{
"Session": {
"ExternalID": ""
},
"Details": {
"Loan": [
{
"LoanType": "New",
"Lender": null,
"LendingAction": null,
"LiabilityType": "HomeLoan",
"LoanAmount": 250000,
"TopUpAmount": null,
"TotalTermMonths": 180,
"InterestOnlyTermMonths": 180,
"Security": {
"Value": 300000,
"IsRBNZExempt": true,
"Location": null,
"PropertyType": [
"ResidentialProperty",
"FreeHoldResidential",
null
],
"SecurityType": "Proposed",
"UsageType": "OwnerOccupied"
},
"LoanId": 1
},
{
"LoanType": "Existing",
"Lender": null,
"LendingAction": "TopUp",
"LiabilityType": "HomeLoan",
"LoanAmount": 250000,
"TopUpAmount": 50000,
"TotalTermMonths": 183,
"InterestOnlyTermMonths": 219,
"Security": {
"Value": 300000,
"isRBNZExempt": false,
"Location": null,
"PropertyType": [
"ResidentialProperty",
"FreeHoldResidential",
null
],
"SecurityType": "Existing",
"UsageType": "OwnerOccupied"
},
"LoanId": 2
},
{
"LoanType": "Existing",
"Lender": null,
"LendingAction": "Refinance",
"LiabilityType": "HomeLoan",
"LoanAmount": 260000,
"TopUpAmount": null,
"TotalTermMonths": 180,
"InterestOnlyTermMonths": 216,
"Security": {
"Value": 300000,
"isRBNZExempt": false,
"Location": null,
"PropertyType": [
"ResidentialProperty",
"FreeHoldResidential",
null
],
"SecurityType": "Proposed",
"UsageType": "OwnerOccupied"
},
"LoanId": 3
},
{
"LoanType": "Existing",
"Lender": null,
"LendingAction": "Refinance",
"LiabilityType": "HomeLoan",
"LoanAmount": 370000,
"TopUpAmount": null,
"TotalTermMonths": 144,
"InterestOnlyTermMonths": 0,
"Security": {
"Value": 410000,
"isRBNZExempt": false,
"Location": null,
"PropertyType": [
null,
null,
null
],
"SecurityType": "Proposed",
"UsageType": null
},
"LoanId": 4
},
{
"LoanType": "Existing",
"Lender": null,
"LendingAction": "TopUp",
"LiabilityType": "HomeLoan",
"LoanAmount": 200000,
"TopUpAmount": 50000,
"TotalTermMonths": 180,
"InterestOnlyTermMonths": 0,
"Security": {
"Value": 210000,
"isRBNZExempt": false,
"Location": null,
"PropertyType": [
null,
null,
null
],
"SecurityType": "Proposed",
"UsageType": null
},
"LoanId": 5
}
],
"ApplicantParty": [
{
"Applicant": [
{
"ApplicantId": 1,
"Name": "Terence"
},
{
"ApplicantId": 2,
"Name": "Eve"
}
],
"Expense": [
{
"ApplicantId": 1,
"ExpenseType": "ChildCare",
"Frequency": "Monthly",
"Amount": 300
},
{
"ApplicantId": 1,
"ExpenseType": "ChildMaintenance",
"Frequency": "Monthly",
"Amount": 10
},
{
"ApplicantId": 1,
"ExpenseType": "HigherEducationAndVocationalTraining",
"Frequency": "Monthly",
"Amount": 200
},
{
"ApplicantId": 1,
"ExpenseType": "OtherEducation",
"Frequency": "Monthly",
"Amount": 100
},
{
"ApplicantId": 1,
"ExpenseType": "PrivateSchoolCosts",
"Frequency": "Monthly",
"Amount": 300
},
{
"ApplicantId": 1,
"ExpenseType": "PublicSchoolCosts",
"Frequency": "Monthly",
"Amount": 150
},
{
"ApplicantId": 1,
"ExpenseType": "Groceries",
"Frequency": "Monthly",
"Amount": 200
},
{
"ApplicantId": 1,
"ExpenseType": "OtherGroceries",
"Frequency": "Monthly",
"Amount": 150
},
{
"ApplicantId": 1,
"ExpenseType": "BodyCorporatePrimaryResidence",
"Frequency": "Monthly",
"Amount": 10
},
{
"ApplicantId": 1,
"ExpenseType": "CouncilRatesPrimaryResidence",
"Frequency": "Monthly",
"Amount": 10
},
{
"ApplicantId": 1,
"ExpenseType": "ElectricityAndGasPrimaryResidence",
"Frequency": "Monthly",
"Amount": 100
},
{
"ApplicantId": 1,
"ExpenseType": "FurnishingsAndElectrical",
"Frequency": "Monthly",
"Amount": 10
},
{
"ApplicantId": 1,
"ExpenseType": "HomeOperation",
"Frequency": "Monthly",
"Amount": 10
},
{
"ApplicantId": 1,
"ExpenseType": "HomeRepairs",
"Frequency": "Monthly",
"Amount": 10
},
{
"ApplicantId": 1,
"ExpenseType": "OtherPrimaryResidenceExpense",
"Frequency": "Monthly",
"Amount": 10
},
{
"ApplicantId": 1,
"ExpenseType": "WaterAndSewerPrimaryResidence",
"Frequency": "Monthly",
"Amount": 10
},
{
"ApplicantId": 1,
"ExpenseType": "BuildingInsurance",
"Frequency": "Monthly",
"Amount": 10
},
{
"ApplicantId": 1,
"ExpenseType": "ContentsInsurance",
"Frequency": "Monthly",
"Amount": 10
},
{
"ApplicantId": 1,
"ExpenseType": "HealthInsurance",
"Frequency": "Monthly",
"Amount": 10
},
{
"ApplicantId": 1,
"ExpenseType": "IncomeProtection",
"Frequency": "Monthly",
"Amount": 10
},
{
"ApplicantId": 1,
"ExpenseType": "LifeInsurance",
"Frequency": "Monthly",
"Amount": 10
},
{
"ApplicantId": 1,
"ExpenseType": "OtherInsurance",
"Frequency": "Monthly",
"Amount": 10
},
{
"ApplicantId": 1,
"ExpenseType": "VehicleInsurance",
"Frequency": "Monthly",
"Amount": 10
},
{
"ApplicantId": 1,
"ExpenseType": "BodyCorporateInvestmentProperty",
"Frequency": "Monthly",
"Amount": 10
},
{
"ApplicantId": 1,
"ExpenseType": "BuildingInsuranceInvestmentProperty",
"Frequency": "Monthly",
"Amount": 10
},
{
"ApplicantId": 1,
"ExpenseType": "CouncilRatesInvestmentProperty",
"Frequency": "Monthly",
"Amount": 10
},
{
"ApplicantId": 1,
"ExpenseType": "ElectricityAndGasInvestmentProperty",
"Frequency": "Monthly",
"Amount": 10
},
{
"ApplicantId": 1,
"ExpenseType": "OtherInvestmentPropertyExpense",
"Frequency": "Monthly",
"Amount": 10
},
{
"ApplicantId": 1,
"ExpenseType": "RepairsAndMaintenanceInvestmentProperty",
"Frequency": "Monthly",
"Amount": 10
},
{
"ApplicantId": 1,
"ExpenseType": "RunningCostsInvestmentProperty",
"Frequency": "Monthly",
"Amount": 10
},
{
"ApplicantId": 1,
"ExpenseType": "WaterAndSewerInvestmentProperty",
"Frequency": "Monthly",
"Amount": 200
},
{
"ApplicantId": 1,
"ExpenseType": "ContentsInsuranceSecondaryResidence",
"Frequency": "Monthly",
"Amount": 10
},
{
"ApplicantId": 1,
"ExpenseType": "BodyCorporateSecondaryResidence",
"Frequency": "Monthly",
"Amount": 10
},
{
"ApplicantId": 1,
"ExpenseType": "BuildingInsuranceSecondaryResidence",
"Frequency": "Monthly",
"Amount": 10
},
{
"ApplicantId": 1,
"ExpenseType": "CouncilRatesSecondaryResidence",
"Frequency": "Monthly",
"Amount": 10
},
{
"ApplicantId": 1,
"ExpenseType": "ElectricityAndGasSecondaryResidence",
"Frequency": "Monthly",
"Amount": 10
},
{
"ApplicantId": 1,
"ExpenseType": "OtherSecondaryResidenceExpense",
"Frequency": "Monthly",
"Amount": 10
},
{
"ApplicantId": 1,
"ExpenseType": "RepairsAndMaintenanceSecondaryResidence",
"Frequency": "Monthly",
"Amount": 10
},
{
"ApplicantId": 1,
"ExpenseType": "RunningCostsSecondaryResidence",
"Frequency": "Monthly",
"Amount": 10
},
{
"ApplicantId": 1,
"ExpenseType": "WaterAndSewerSecondaryResidence",
"Frequency": "Monthly",
"Amount": 10
},
{
"ApplicantId": 1,
"ExpenseType": "MedicalAndHealth",
"Frequency": "Monthly",
"Amount": 10
},
{
"ApplicantId": 1,
"ExpenseType": "NaturalTherapies",
"Frequency": "Monthly",
"Amount": 10
},
{
"ApplicantId": 1,
"ExpenseType": "Board",
"Frequency": "Monthly",
"Amount": 10
},
{
"ApplicantId": 1,
"ExpenseType": "DryCleaning",
"Frequency": "Monthly",
"Amount": 10
},
{
"ApplicantId": 1,
"ExpenseType": "AlcoholTobacco",
"Frequency": "Monthly",
"Amount": 10
},
{
"ApplicantId": 1,
"ExpenseType": "CinemaConcertsMemberships",
"Frequency": "Monthly",
"Amount": 10
},
{
"ApplicantId": 1,
"ExpenseType": "GymSports",
"Frequency": "Monthly",
"Amount": 10
},
{
"ApplicantId": 1,
"ExpenseType": "OtherRecreationalAndEntertainment",
"Frequency": "Monthly",
"Amount": 10
},
{
"ApplicantId": 1,
"ExpenseType": "Pets",
"Frequency": "Monthly",
"Amount": 10
},
{
"ApplicantId": 1,
"ExpenseType": "HomeMobilePhone",
"Frequency": "Monthly",
"Amount": 10
},
{
"ApplicantId": 1,
"ExpenseType": "InternetPayTVAndMediaStreamingSubscriptions",
"Frequency": "Monthly",
"Amount": 10
},
{
"ApplicantId": 1,
"ExpenseType": "PublicTransport",
"Frequency": "Monthly",
"Amount": 10
},
{
"ApplicantId": 1,
"ExpenseType": "Registration",
"Frequency": "Monthly",
"Amount": 10
},
{
"ApplicantId": 1,
"ExpenseType": "TaxiRideSharing",
"Frequency": "Monthly",
"Amount": 10
},
{
"ApplicantId": 1,
"ExpenseType": "TollsParking",
"Frequency": "Monthly",
"Amount": 10
},
{
"ApplicantId": 1,
"ExpenseType": "Kiwisaver",
"Frequency": "Monthly",
"Amount": 10
},
{
"ApplicantId": 1,
"ExpenseType": "RegularDonations",
"Frequency": "Monthly",
"Amount": 10
},
{
"ApplicantId": 1,
"ExpenseType": "VoluntarySaving",
"Frequency": "Monthly",
"Amount": 10
},
{
"ApplicantId": 1,
"ExpenseType": "VoluntarySuper",
"Frequency": "Monthly",
"Amount": 10
}
],
"Income": [
{
"ApplicantId": 1,
"Frequency": "Yearly",
"Amount": 50000,
"AmountType": "Gross",
"IncomeType": "SalaryWages",
"Attributes": []
},
{
"ApplicantId": 1,
"Frequency": "Yearly",
"Amount": 5000,
"AmountType": null,
"IncomeType": "RentalIncome",
"Attributes": [
{
"name": "PropertyBuildDate",
"value": "2018-11-06"
},
{
"name": "PropertyCountry",
"value": "NZ"
},
{
"name": "IsTaxExempt",
"value": true
},
{
"name": "SalePurchaseDate",
"value": "2019-11-11"
}
]
},
{
"ApplicantId": 2,
"Frequency": "Yearly",
"Amount": 40000,
"AmountType": "Gross",
"IncomeType": "SalaryWages",
"Attributes": []
},
{
"ApplicantId": 2,
"Frequency": "Yearly",
"Amount": 5000,
"AmountType": null,
"IncomeType": "WorkAllowance",
"Attributes": []
},
{
"ApplicantId": 1,
"Frequency": "Yearly",
"Amount": 10000,
"AmountType": null,
"IncomeType": "Bonus",
"Attributes": []
},
{
"ApplicantId": 1,
"Frequency": "Yearly",
"Amount": 4000,
"AmountType": null,
"IncomeType": "BoarderIncome",
"Attributes": [
{
"name": "BoarderIncomeType",
"value": "AllInclusive"
}
]
},
{
"ApplicantId": 1,
"Frequency": "Yearly",
"Amount": 3000,
"AmountType": null,
"IncomeType": "CarAllowance",
"Attributes": []
},
{
"ApplicantId": 1,
"Frequency": "Yearly",
"Amount": 5000,
"AmountType": null,
"IncomeType": "FamilyAllowance",
"Attributes": []
}
],
"Liability": [
{
"ApplicantId": 1,
"LiabilityType": "HomeLoan",
"RepaymentAmount": 2000,
"RepaymentFrequency": "Monthly",
"Limit": 4000,
"Balance": 10000,
"InterestRate": 0.02,
"RepaymentType": "PrincipalInterest",
"StartDate": "2017-11-15",
"TotalTermMonths": 228,
"InterestOnlyTermMonths": 228,
"Lender": "Kiwibank",
"IsRevolvingCredit": true
},
{
"ApplicantId": 1,
"LiabilityType": "CreditCard",
"RepaymentAmount": null,
"RepaymentFrequency": null,
"Limit": 30000,
"Balance": null,
"InterestRate": null,
"RepaymentType": null,
"StartDate": null,
"TotalTermMonths": null,
"InterestOnlyTermMonths": null,
"Lender": null,
"IsRevolvingCredit": null
},
{
"ApplicantId": 1,
"LiabilityType": "PersonalLoan",
"RepaymentAmount": 2000,
"RepaymentFrequency": "Monthly",
"Limit": 4000,
"Balance": 30000,
"InterestRate": 0.02,
"RepaymentType": null,
"StartDate": "2019-11-07",
"TotalTermMonths": 220,
"InterestOnlyTermMonths": null,
"Lender": null,
"IsRevolvingCredit": true
},
{
"ApplicantId": 1,
"LiabilityType": "Other",
"RepaymentAmount": 200,
"RepaymentFrequency": "Monthly",
"Limit": 4000,
"Balance": 10000,
"InterestRate": 0.01,
"RepaymentType": null,
"StartDate": "2018-11-07",
"TotalTermMonths": 183,
"InterestOnlyTermMonths": null,
"Lender": "Kiwibank",
"IsRevolvingCredit": true
},
{
"ApplicantId": 1,
"LiabilityType": "HirePurchase",
"RepaymentAmount": 2000,
"RepaymentFrequency": "Monthly",
"Limit": null,
"Balance": 20000,
"InterestRate": null,
"RepaymentType": null,
"StartDate": null,
"TotalTermMonths": null,
"InterestOnlyTermMonths": null,
"Lender": null,
"IsRevolvingCredit": null
},
{
"ApplicantId": 1,
"LiabilityType": "Overdraft",
"RepaymentAmount": 2000,
"RepaymentFrequency": "Monthly",
"Limit": 4000,
"Balance": 20000,
"InterestRate": 0.02,
"RepaymentType": null,
"StartDate": null,
"TotalTermMonths": null,
"InterestOnlyTermMonths": null,
"Lender": null,
"IsRevolvingCredit": null
},
{
"LoanId": 2,
"Lender": null,
"Balance": 195000,
"Limit": 250000,
"InterestRate": 1,
"RepaymentAmount": 15000,
"RepaymentFrequency": "Monthly",
"RepaymentType": null,
"TotalTermMonths": 183,
"StartDate": null,
"IsRevolvingCredit": null,
"InterestOnlyTermMonths": 216,
"ApplicantId": 1,
"LiabilityType": "HomeLoan"
},
{
"Lender": null,
"Balance": 200000,
"Limit": 260000,
"InterestRate": 2,
"RepaymentAmount": 10000,
"RepaymentFrequency": "Monthly",
"RepaymentType": "PrincipalInterest",
"TotalTermMonths": 180,
"StartDate": null,
"IsRevolvingCredit": null,
"InterestOnlyTermMonths": 216,
"ApplicantId": 1,
"LiabilityType": "HomeLoan",
"LoanId": 3
}
],
"NumberOfDependents": 1,
"NumberOfVehicles": 1
}
]
},
"Lenders": []
}
Response
✅ Success
JSON Body
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Response JSON Body",
"type": "object",
"properties": {
"SessionID": {
"type": "string",
"description": "20 characters in length, random generated alphanumeric string, mixed case"
}
}
}Examples
Success Response
{
"SessionID": "BYWSw2DTUBuHVMW4ZdhK"
}❌ Error
JSON Body
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"description": "Error information",
"properties": {
"message": {
"type": "string",
"description": "Human readable error message"
},
"status": {
"type": "string",
"description": "Error code in uppercase letters and _ as space",
"enum": ["INVALID_ARGUMENT","DEADLINE_EXCEEDED","NOT_FOUND","ALREADY_EXISTS","PERMISSION_DENIED","RESOURCE_EXHAUSTED","FAILED_PRECONDITION","ABORTED","OUT_OF_RANGE","UNIMPLEMENTED","INTERNAL","UNAVAILABLE","DATA_LOSS","UNAUTHENTICATED"]
},
"details": {
"type": "object",
"description": "Additional error details",
"properties": {
"validation_errors": {
"type": "array",
"description": "Errors thrown when validating input data",
"items": {
"type": "object",
"properties": {
"path": {
"type": "array",
"description": "An array of property keys or array offsets, indicating where inside objects or arrays the instance was found.",
"items": {
"type": "string"
}
},
"property": {
"type": "string",
"description": "Describes the property path. Starts with `instance`, and is delimited with a dot (.)."
},
"message": {
"type": "string",
"description": "A human-readable message for debugging use. Provided in English and subject to change."
},
"schema": {
"type": "object",
"description": "The schema containing the keyword that failed",
"properties": {
"type": {
"type": "string"
},
"description": {
"type": "string"
}
},
"required": ["type"]
},
"instance": {
"description": "The instance (value) that failed",
"type": ["null", "object"]
},
"name": {
"type": "string",
"description": "The keyword within the schema that failed."
},
"argument": {
"type": "array",
"description": "Provides information about the keyword that failed.",
"items": {
"type": "string"
}
},
"stack": {
"type": "string"
}
}
}
}
}
}
}
}
},
"required": ["path", "property", "message", "schema", "instance", "name", "argument", "stack"]
}Examples
Missing API Key (Status: 401)
{
"error": {
"message": "Missing API Key",
"status": "UNAUTHENTICATED"
}
}
Invalid API Key (Status: 401)
{
"error": {
"message": "Invalid API Key",
"status": "UNAUTHENTICATED"
}
}
Invalid data (Status: 400)
{
"error": {
"message": "Invalid data",
"status": "INVALID_ARGUMENT",
"details": {
"validation_errors": [
{
"path": [
"Details",
"Loan",
0,
"LoanType"
],
"property": "instance.Details.Loan[0].LoanType",
"message": "is not one of enum values: Existing,Proposed",
"schema": {
"type": "string",
"description": "Defines whether the applicant already has this loan or if it's a new loan",
"enum": [
"Existing",
"New"
]
},
"instance": "Proposed",
"name": "enum",
"argument": [
"Existing",
"Proposed"
],
"stack": "instance.Details.Loan[0].LoanType is not one of enum values: Existing,Proposed"
}
]
}
}
}