Field reference – response for home
Sample request
{ "policyHeader": { "insurancePeriodStartDate": "2022-09-08", "policyQuoteInformation": { "quoteNumber": "3217037", "quoteNumberPrefix": "QS2" }, "transactionInformation": { "contractStage": "Quote", "processStatus": "Incomplete" }, "policyNumberDetail": { "companyCode": "1", "branchCode": "63", "productCode": "LLP" }, "policyIntermediary": { "intermediaryId": "TESTPARTNER", "branchCode": "63", "agentCode": "0000314", "agentName": "TEST PARTNER NSW/ACT NB", "placingOfficerCode": "HOSTAFFMC", "placingOfficerName": "Loan Consultant" } }, "references": [ { "type": "LOAN_APP_NUM", "value": "12345678901234" }, { "type": "CUST_NUM", "value": "1849310" }, { "type": "SUBMISSION_ID", "value": "QS23217037_aPFWQDVCtQTFfu_hEi1oZsEJhvUY940hsRuKwZ8rLVlGActSnKFPM7owmYJvqcsc8JhWxX3zfrijaQ" } ], "policyInsureds": [ { "type": "PRIMARY", "person": { "mailingAddress": { "lineOne": "Level 10 100 Pacific Hwy", "suburbName": "NORTH SYDNEY", "stateOrProvinceCode": "NSW", "postalCode": "2060", "countryCode": "AUS", "countryName": "AUSTRALIA" }, "telephoneNumbers": [ { "typeCode": "Mobile", "phoneAreaCode": "4620" } ], "personName": { "surname": "Niroula", "givenName": "Dhiraj" } } }, { "type": "CO_INSURED", "person": { "telephoneNumbers": [ { "typeCode": "Mobile", "phoneAreaCode": "0430", "phoneNumber": "576577" } ], "emailAddresses": [ { "emailAddress": "test@testpartner.com.au", "preferred": true } ], "personName": { "surname": "Prasad", "givenName": "Ash" } } } ], "policyProperty": { "riskAddress": { "lineOne": "1 Lacks Pl", "suburbName": "CAMPBELLTOWN", "stateOrProvinceCode": "NSW", "postalCode": "2560", "countryCode": "AUS" } } }
| Response 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. |
| policyQuoteInformation | Root element | Optional | Contains details of the officer initiating the request. |
| quoteNumber | String | Required | Identifies the quote in our sales system. |
| quoteNumberPrefix | String | Required | This is the prefix of the quote number in our sales system. |
| transactionInformation | Root element | Optional | Contains details of the officer initiating the request. |
| contractStage | String | Required | This indicates the current stage of the quote. |
| processStatus | String | Required |
This describes the status of the quote. Details of the different process statuses can be found in the Response status details section on the Getting started page. |
| policyNumberDetail | String | Required | This provides detailed information about the policy. |
| companyCode | String | Required | Company Code specified for which insurance product has been issued. |
| branchCode | String | Required | ranch code of the product. |
| 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. |
| agentCode | String | Required | The batch ID or user ID that was created during the quote process. |
| agentOfficerName | String | Required | The name of the event or user that has been triggered. |
| 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. |
| 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 submission ID. |
| value | String | Required | The details of the type given above. |
| policyInsureds | Root element | Required | Contact details of the policy holder. |
| person | Root element | Required (if it’s an individual or private request) | Details of the person, if applicable. |
| organization | Root element | Required (if it’s a group or company request) | Details of the company, if applicable. |
| 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 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). |
| mailingAddress | Root element | Optional | Address of the person or company. |
| lineOne | String | Required | Describes the unstructured details of a property, including street-level information. |
| suburbName | String | Required | The suburb where the address is located. |
| 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. |
| 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. |
| countryCode | String | Required | Code of the country (AUS). |
| telephoneNumbers | Root element | Optional | Telephone numbers for the person or company, whichever is applicable. |
| typeCode | String | Required | This indicates if it’s a landline or mobile number. |
| 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. |
| emailAddresses | String | Required (if using the Safety Net Price Estimate API) | The email addresses of the person or company, whichever is applicable. |
| preferred | Boolean | Required | Indicates the preferred email address when multiple email addresses are provided. |
| personName | Root element | Required | The customer’s details as listed below. |
| givenName | Required | The first name of the person. | |
| Surname | String | Required | The family name of the person. |
| policyProperty | Root element | Required | Key details about the property. For example, a building valuation, home loan application, purpose of the loan or occupancy type. |
| riskAddress | Root element | Required | The mailing address of the person or company. |
