Request body structure for home products
Field reference – request for home products
Sample request
{ "policyHeader": { "insurancePeriodStartDate": "2024-02-09", "policyIntermediary": { "intermediaryId": "NABFML", "placingOfficerCode": "OUTBOUND", "placingOfficerName": "Jane Doe", "placingOfficerEmployeeID": "P123456", "placingOfficerEmail": "abc@allianz.com.au" } }, "policyInsureds": [ { "person": { "emailAddresses": [ { "emailAddress": "thdev@corp.aal.au", "preferred": true } ], "mailingAddress": { "countryCode": "AUS", "countryName": "AUSTRALIA", "lineOne": "Unit 200, Level 5, 10 GEORGE ST", "postalCode": 2000, "stateOrProvinceCode": "NSW", "suburbName": "SYDNEY" }, "personName": { "givenName": "John", "surname": "Smith" }, "telephoneNumbers": [ { "phoneAreaCode": "0412", "phoneCountryCode": "+61", "phoneNumber": "123456", "typeCode": "Mobile" }, { "phoneAreaCode": "02", "phoneCountryCode": "+61", "phoneNumber": 95551234, "typeCode": "Home" }, { "phoneAreaCode": "02", "phoneCountryCode": "+61", "phoneNumber": 99999999, "typeCode": "Work" } ] }, "type": "PRIMARY" }, { "person": { "emailAddresses": [ { "emailAddress": "abc@def.com.au", "preferred": true } ], "personName": { "givenName": "Jane", "surname": "Smith" }, "telephoneNumbers": [ { "phoneAreaCode": "0456", "phoneCountryCode": "+61", "phoneNumber": 12345678, "typeCode": "Mobile" } ] }, "type": "COINSURED" } ], "policyProperty": { "buildingValuation": 389626, "homeLoanApplication": true, "loanPurpose": "re-financing", "occupancy": { "occupancyType": "Owner", "oldestOccupantDateOfBirth": "1980-01-02", "weeklyRentCollected": "900" }, "riskAddress": { "countryCode": "AUS", "countryName": "AUSTRALIA", "lineOne": "5 Bella Vista Crescent", "postalCode": 3810, "stateOrProvinceCode": "VIC", "suburbName": "Pakenham" }, "strataTitleFlag": false }, "references": [ { "type": "LOAN_APP_NUM", "value": "R1234-5678-90AB" }, { "type": "CUST_NUM", "value": "000000008" }, { "type": "DISCOUNT_CODE", "value": "QL" } ] }
| Request field | Field type | Status | Description |
|---|---|---|---|
| policyHeader | Root element | Required | Contains policy details like the policy start date and name of the officer initiating the request. |
| insurancePeriodStartDate | String | Required | The insurance start state. This should be in the format yyyy-MM-dd. Typically, this is the settlement date of the purchase. If there’s no settlement date, use today’s date instead. |
| policyIntermediary | Root element | Required | Contains details of the officer initiating the request. |
| intermediaryId | String | Required | Identifies your company within our sales system. Your account manager can provide this to you. |
| placingOfficerCode | String | Required | Identifies the person who initiated the transaction in our sales system. |
| placingOfficerName | String | Required | Full name of the person who placed the transaction in our sales system. |
| placingOfficerEmployeeID | String | Optional | Employee ID of the person who placed the transaction in our sales system. |
| placingOfficerEmail | String | Optional | Email of the person who placed the transaction in our sales system. |
| policyInsureds | Root element | Required | Contact details of the policy holder. |
| person | Root element | Required | Details of the insured policyholder. |
| organisation | Root element | Required (if it’s a group or company request) | Details of the company, if applicable. |
| emailAddresses | String | Required (if using the Safety Net Price Estimate API) | The email addresses of the person or company, whichever is applicable. |
| emailAddress | String | Required | The email address of the person or company, whichever is applicable. |
| preferred | Boolean | Required | Indicates the preferred email address when multiple email addresses are provided. |
| mailingAddress | Root element | Optional | Address of the person or company. |
| countryCode | String | Required | Code of the country (AUS). |
| countryName | String | Required | Name of the country (Australia). |
| lineOne | String | Required | Describes the unstructured details of a property, including street-level information. |
| postalCode | String | Required | The four digit postcode of the address. This should be provided in a valid Postal Address Format (PAF) or as an Australia Post value. |
| stateOrProvinceCode | String | Required | The state or province where the address is located. This should be provided in a valid Postal Address Format (PAF) or as an Australia Post value. |
| suburbName | String | Required | The suburb where the address is located. |
| personName | Root element | Required | The customer’s details as listed below. |
| givenName | String | Required | The first name of the person. |
| surname | String | Required | The family name of the person. |
| telephoneNumbers | Root element | Optional | Telephone numbers for the person or company, whichever is applicable. |
| phoneAreaCode | String | Required | The two-digit area code of a landline number, or the first four digits of a mobile number. |
| phoneCountryCode | String | Required | The country code of the phone number (+61 for Australian numbers). |
| phoneNumber | String | Required | This is the eight digits of a landline, or last six digits of a mobile number. |
| typeCode | String | Required | This indicates if it’s a landline or mobile number. |
| type | String | Required |
This section represents the entities (either a person or company) to be insured on the quote. Only one entity in the list can be designated as PRIMARY, which can either be a person or a company. Additional entities can be identified as COINSURED, but they must be individuals. The list can contain a maximum of five entities: one PRIMARY (person or company) and up to four COINSURED (individuals). |
| policyProperty | Root element | Required | Details of the property as supplied below. |
| buildingSumInsured | String | Optional |
This is the actual building valuation. If a customer-confirmed building sum insured is not available, you can supply one of the following:
The estimated building valuation can be expressed as a percentage of the security property's total valuation (including both building and land). This percentage should be calculated within your system. We’ll determine the exact percentage together as part of your API onboarding. The value needs to be a whole number without formatting. This means no commas or decimals are allowed. For example, 660000 is allowed, but not 660000.66 or 660,000 |
| buildingValuation | String | Optional |
This is the estimated building valuation. If a customer-confirmed building sum insured is not available, you can supply one of the following:
The estimated building valuation can be expressed as a percentage of the security property's total valuation (including both building and land). This percentage should be calculated within your system. We’ll determine the exact percentage together as part of your API onboarding. The value needs to be a whole number without formatting. This means no commas or decimals are allowed. For example, 660000 is allowed, but not 660000.66 or 660,000 |
| contentsSumInsured | String | Optional | The actual contents of the sum insured. |
| homeLoanApplication | Boolean | Required | This determines if this is being done as part of the home loan journey. Value: true/false |
| loanPurpose | String | Optional | The purpose of the loan on the property – i.e. re-financing. |
| occupancy | Root element | Required | The occupancy details of the property. |
| occupancyType | String | Required | The purpose of the loan on the property. Accepted values for this field are: owner and landlord. |
| oldestOccupantDateOfBirth | String | Required | The oldest Occupant’s date of birth. It should be in the format yyyy-MM-dd. |
| weeklyRentCollected | String | Optional | The weekly rent collected for a tenanted property. |
| riskAdddress | Root element | Required | Communication address of the person or company. |
| strataTitleFlag | Boolean | Required | This states whether the property is under a strata title. |
| references | Root element | Required | Your system’s loan application number and customer number. |
| type | String | Required | The type of the number. This could be a loan application number, customer number or discount code. The customer number is a mandatory field. |
| value | String | Required | The value of the above number types. |
