Request body structure
Field reference - request
<SOAP-ENV:Envelope><SOAP-ENV:Body><PolicyLeadRequest xmlns=http://xsd.allianz.com.au/aal/mm/2_0_0> <MessageHeader><log:LoggingHeader xmlns:log="http://xsd.logging.allianz.com.au"><log:MessageId>f960f054-2fb2-472d-bfc9-b561abac8d71</log:MessageId><log:CorrelationId>61debe47-b538-4a59-970a-66e967303fc8</log:CorrelationId><log:MessageDateTime>2017-03-20T16:28:19</log:MessageDateTime><log:BusinessId>123456789</log:BusinessId><log:UserId>User Id</log:UserId><log:ApplicationName>SYSTEM</log:ApplicationName>lt;/log:LoggingHeader><SendingSystem><SystemVendorId>TEST</SystemVendorId><SystemVendorName>TEST</SystemVendorName><VendorProductName>TEST SYSTEM</VendorProductName><VendorProductVersion>1</VendorProductVersion></SendingSystem></MessageHeader> <ns6:OriginatingSystem><ns6:SystemVendorId>TEST001</ns6:SystemVendorId><ns6:SystemVendorName>Test Choice Limited</ns6:SystemVendorName><ns6:VendorProductName>TESTProduct</ns6:VendorProductName><ns6:VendorProductVersion>1.0.0.0</ns6:VendorProductVersion></ns6:OriginatingSystem><ns6:Address key="addr1"><ns6:LineOne>Unknown</ns6:LineOne><ns6:SuburbName>TESTNAME</ns6:SuburbName><ns6:StateOrProvinceName>SA</ns6:StateOrProvinceName><ns6:PostalCode>1234</ns6:PostalCode><ns6:CountryName>Australia</ns6:CountryName></ns6:Address><ns6:Organisation key="org1"/><ns6:PolicyInsured><ns6:RoleCode>Insured</ns6:RoleCode><ns6:Person key="pers1"><ns6:Telephone><ns6:PreferredFlag>false</ns6:PreferredFlag><ns6:DoNotContactFlag>false</ns6:DoNotContactFlag><ns6:TypeCode>Mobile</ns6:TypeCode><ns6:PreferredContactTime>9:00:00</ns6:PreferredContactTime><ns6:DayFlag>true</ns6:DayFlag><ns6:EveningFlag>false</ns6:EveningFlag><ns6:PhoneNumber>0444444444</ns6:PhoneNumber></ns6:Telephone><ns6:Email><ns6:PreferredFlag>false</ns6:PreferredFlag><ns6:DoNotContactFlag>false</ns6:DoNotContactFlag><ns6:EmailAddress>Serenabella@test.com</ns6:EmailAddress></ns6:Email><ns6:MailingAddress addressReference="addr1"><ns6:PreferredFlag>false</ns6:PreferredFlag><ns6:DoNotContactFlag>false</ns6:DoNotContactFlag></ns6:MailingAddress><ns6:LegalAddress addressReference="addr1"/><ns6:PersonName><ns6:Surname>SName</ns6:Surname><ns6:GivenName>GName</ns6:GivenName><ns6:MiddleName>MName</ns6:MiddleName><ns6:AbbreviatedName>ANAme</ns6:AbbreviatedName></ns6:PersonName><ns6:GenderCode>Female</ns6:GenderCode><ns6:BirthDate>1980-01-01</ns6:BirthDate></ns6:Person></ns6:PolicyInsured><ns6:CoverageInceptionDate>2022-09-01</ns6:CoverageInceptionDate><ns6:PolicyProperty key="prop1"><ns6:PurchasePriceAmount>393315</ns6:PurchasePriceAmount>ns6:Structure key="255f9b78-7e29-ed11-811c-00155d7d1928"/></ns6:PolicyProperty><ns6:PolicyIntermediary key="polinter1"><ns6:PlacingOfficerUserId>AZ123456</ns6:PlacingOfficerUserId><ns6:PlacingOfficerCode>AZ123456</ns6:PlacingOfficerCode><ns6:PlacingOfficerName>Test Officer</ns6:PlacingOfficerName><ns6:Intermediary key="inter1"><ns6:IntermediaryId>TESTPARTNER</ns6:IntermediaryId><ns6:Contact><ns6:PersonName><ns6:Surname>Test Surname</ns6:Surname><ns6:GivenName>Test</ns6:GivenName></ns6:PersonName><ns6:Email><ns6:EmailAddress>test@partner.com.au</ns6:EmailAddress></ns6:Email></ns6:Contact></ns6:Intermediary></ns6:PolicyIntermediary><ns6:PolicyInterestedParty key="party1"><ns6:RoleCode>Financier</ns6:RoleCode></ns6:PolicyInterestedParty><ns6:LeadReferenceIdentifier><ns6:Id>255f9b78-7e29-ed11-811c-00155d7d1928</ns6:Id></ns6:LeadReferenceIdentifier><ns6:LoanAmount>393315</ns6:LoanAmount><ns6:BuildingRequestedFlag>true</ns6:BuildingRequestedFlag><ns6:ContentsRequestedFlag>true</ns6:ContentsRequestedFlag><ns6:LandlordRequestedFlag>false</ns6:LandlordRequestedFlag><ns6:MotorRequestedFlag>false</ns6:MotorRequestedFlag><ns6:CaravanTrailerRequestedFlag>false</ns6:CaravanTrailerRequestedFlag><ns6:PreferredContactDate>2022-09-29</ns6:PreferredContactDate><ns6:LoanPurpose>Restructure</ns6:LoanPurpose><ns6:Comments/><ns6:Consent>Yes</ns6:Consent></PolicyLeadRequest></SOAP-ENV:Envelope></SOAP-ENV:Body>
| Request field | Field type | Status | Description |
|---|---|---|---|
| OriginatingSystem | Root element | Required | This includes details about the system that is sending the request. |
| SystemVendorId | String | Required | Your company’s code that is logged in our sales system. |
| SystemVendorName | String | Required | Your company’s name that is logged in our sales system. |
| VendorProductName | String | Required | The name of your company’s application that is logged in our system. |
| VendorProductVersion | String | Required | This is used for versioning and lets us map differences without needing to change namespaces. |
| Address | Root element | Optional | This can contain multiple addresses which come from the insured and policy property. The link is made using a key. |
| LineOne | String | Required (if Address element specified) |
Describes the unstructured details of a property, including street-level information. |
| SuburbName | String | Required (if Address element specified) |
The suburb where the address is located. |
| StateOrProvinceName | String | Required (if Address element specified) |
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 (if Address element specified) |
The four digit postcode of the address. This should be provided in a valid Postal Address Format (PAF) or as an Australia Post value. |
| CountryName | String | Required (if Address element specified) |
Name of the country (Australia). |
| Organisation | Root element | Optional | Contains details of the company sending the request. |
| PolicyInsured | Root element | Optional |
There can be multiple insured or co-insured parties. They can be either a company or person. We’ll need the ‘primary’ insured to be listed first, followed by co-insured parties. If a company is involved, there should only be one entry. |
| RoleCode | String | Required (if PolicyInsured element specified) | This is either ‘Insured’ (the primary policyholder) or ‘CoInsured’. The ‘Insured’ will always be the first person in the XML. |
| Person | Root element | Optional | The ‘Person’ can refer to either an individual or a company as we do not currently have a dedicated ‘Organisation’ request field. |
| Telephone | Root element | Optional | The phone numbers of the person or company, whichever is applicable. |
| PreferredFlag | Boolean | Required (if Telephone element specified) | This identifies the preferred contact address or phone number if multiple options are listed. |
| DoNotContactFlag | Boolean | Required (if Telephone element specified) | This indicates if the address or phone number cannot be used as the primary contact. |
| TypeCode | String | Required (if Telephone element specified) | This indicates if it’s a landline or mobile number. |
| PreferredContactTime | String | Optional (if Telephone element specified) | When the person prefers to be contacted for a quote. This is always in a 24-hour format. |
| DayFlag | Boolean | Required (if Telephone element specified) | This indicates if customer can be contacted during the day. |
| EveningFlag | Boolean | Required (if Telephone element specified) | This indicates if customer can be contacted in the evening. |
| PhoneNumber | String | Required (if Telephone element specified) | This is the eight digits of a landline, or last six digits of a mobile number. |
| Root element | Optional | The email address details as listed below. | |
| EmailAddress | String | Required (if email element specified) | The email address of the person or company, whichever is applicable. |
| MailingAddress | Root element | Optional | The postal address of the person or company, whichever is applicable. |
| LegalAddress | Root element | Optional | The organisation’s address, if applicable. |
| PersonName | Root element | Optional | The customer’s details as listed below. |
| Surname | String | Required (if PersonName element specified) | The family name of the customer. |
| GivenName | String | Required (if PersonName element specified) | The first name of the customer or company. |
| MiddleName | String | Required (if PersonName element specified) | The middle name of the customer. |
| AbbreviatedName | String | Optional | The short name of the customer or organisation. |
| GenderCode | String | Optional | The customer’s gender. |
| BirthDate | String | Optional | The customer’s date of birth. |
| CoverageInceptionDate | String | Optional |
The date when the insurance coverage should begin. It should be formatted as yyyy-MM-dd. This is typically the settlement date of the property purchase. |
| PolicyProperty | Root element | Optional | The details of the property or properties. There is one policy property per property. |
| PurchasePriceAmount | Decimal | Optional | The value of the property (not the loan). |
| Structure | String | Optional | The property type, such as a house, unit or semi. |
| PolicyIntermediary | Root element | Required | This indicates who sent us the sales lead. |
| PlacingOfficerUserId | String | Required | The unique user ID of the intermediary. |
| PlacingOfficerCode | String | Required | This identifies the person who entered the transaction into our sales system. |
| PlacingOfficerName | String | Required | The full name of the person who entered the transaction into our sales system. |
| IntermediaryId | String | Required | Identifies your company within our sales system. Your account manager will provide this to you. |
| Contact | Root element | Required | Contact details of your company’s salesperson. |
| PolicyInterestedParty | Root element | Optional | The interested party or financier, also known as a mortgagee. |
| LeadReferenceIdentifier | Root element | Optional | This is your company’s unique identifier for the loan application or lead as listed below. |
| Id | String | Optional | This is your company’s unique identifier for the loan application or lead. |
| LoanAmount | Decimal | Optional | The total loan amount, if available. |
| BuildingRequestedFlag | Boolean | Optional | This indicates if the customer wants building (owner) cover. |
| ContentsRequestedFlag | Boolean | Optional | This indicates if the customer wants contents cover. |
| LandlordRequestedFlag | Boolean | Optional | This indicates if the customer wants building (landlord) cover. |
| MotorRequestedFlag | Boolean | Optional | This indicates if the customer wants motor cover. |
| CaravanTrailerRequestedFlag | Boolean | Optional | This indicates if the customer wants Caravan and Trailer cover. |
| PreferredContactDate | String | Optional | The date customer wants to be contacted on. |
| LoanPurpose | String | Optional | The purpose of the loan. |
| Comments | String | Optional | Comments/remarks if applicable. |
| Consent | String | Required |
This is the customer’s consent to be contacted by an Allianz representative. This field is always ‘Yes’. |
