Field reference – response for motor
Sample request
<policy><policyHeader><insurancePeriodStartDate>2023-07-14</insurancePeriodStartDate><policyIntermediary><agentCode>0000019</agentCode><agentName>TEACHERS MUTUALBANK</agentName><branchCode>02</branchCode><intermediaryId>NSWTCUL</intermediaryId><placingOfficerCode>OUTBOUND</placingOfficerCode><placingOfficerName>Jane Doe</placingOfficerName></policyIntermediary><policyNumberDetail><branchCode>02</branchCode><companyCode>1</companyCode><productCode>CMP</productCode></policyNumberDetail><policyQuoteInformation><quoteNumber>332538</quoteNumber><quoteNumberPrefix>QS2</quoteNumberPrefix><quotePreparedDate>2023-07-14</quotePreparedDate><quoteValidUntilDate>2023-07-15</quoteValidUntilDate></policyQuoteInformation><premium><commission>52.60</commission><commissionGST>6.31</commissionGST><fireServicesLevy>0.00</fireServicesLevy><gross>648.05</gross><gst>63.12</gst><net>526.02</net><stampDuty>58.91</stampDuty></premium><transactionInformation><contractStage>Quote</contractStage><processStatus>Complete</processStatus></transactionInformation></policyHeader><references><references><type>CUST_NUM</type><value>C123456789</value></references><references><type>SUBMISSION_ID</type><value>QS2332538_UbVDsDZH7QN94ss81XoLg9qxYcL9bbtLmbOkofBG81ZbzQpNAKAwXWsHWI9FhRpTirmGjL9aLRaW</value></references></references><policyInsureds><policyInsureds><person><mailingAddress><countryCode>AUS</countryCode><countryName>AUSTRALIA</countryName><postalCode>2000</postalCode><stateOrProvinceCode>NSW</stateOrProvinceCode><suburbName>SYDNEY</suburbName></mailingAddress><telephoneNumbers><telephoneNumbers><phoneAreaCode>0456</phoneAreaCode><phoneNumber>123456</phoneNumber><typeCode>Mobile</typeCode></telephoneNumbers></telephoneNumbers><emailAddresses><emailAddresses><emailAddress>abc@def.com.au</emailAddress><preferred>true</preferred></emailAddresses></emailAddresses><personName><givenName>John</givenName><surname>Smith</surname></personName></person><type>PRIMARY</type></policyInsureds><policyInsureds><person><mailingAddress><countryCode>AUS</countryCode><countryName>AUSTRALIA</countryName><postalCode>2000</postalCode><stateOrProvinceCode>NSW</stateOrProvinceCode><suburbName>SYDNEY</suburbName></mailingAddress><telephoneNumbers><telephoneNumbers><phoneAreaCode>0456</phoneAreaCode><phoneNumber>56781234</phoneNumber><typeCode>Mobile</typeCode></telephoneNumbers></telephoneNumbers><emailAddresses><emailAddresses><emailAddress>def@def.com.au</emailAddress><preferred>true</preferred></emailAddresses></emailAddresses><personName><givenName>Jane</givenName><surname>Smith</surname></personName></person><type>CO_INSURED</type></policyInsureds></policyInsureds><policyVehicle><vehicle><manufacturer><manufacturerName>MAZDA</manufacturerName><modelCode>EY905I</modelCode><modelName>MX-5</modelName><modelYear>2005</modelYear></manufacturer></vehicle></policyVehicle></policy>
| 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 | Branch 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 value 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 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). |
| 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 | String | Required | The first name of the person. |
| Surname | String | Required | The family name of the person. |
| policyHeader | Root element | Required | Contains policy details like the policy start date and name of the officer initiating the request. |
| policyVehicle | Root element | The details of the vehicle. | |
| manufacturer | Root element | Manufacture information about the vehicle. |
