SPOT AND REFER GUIDELINES

Spot and Refer

This API is SOAP based that helps to allow insurance sale leads to be pushed to Allianz. Leads are followed up by Allianz staff on behalf of the partner.

Business Use case

A fire-and-forget capability whereby the partner system sends sales lead information into Allianz’s sales application. The lead information contains (at a minimum) enough information for Allianz sales staff to contact the customer and complete the quote. The outcomes of leads are provided through back-channel batch reporting.

Technical Overview

The Spot & Refer API is exposed via the POST/PolicyLeadService and uses SOAP as the transfer protocol.

The examples focus on the essential programming tasks for creating a Spot and Refer Service, taking advantage of default settings when possible.

POST wmb_gateway_ext/dp_gw/lead

Note: Refer to Environment URLs page under Overview/Guidelines/Documentation for complete URL for each environment.

Authentication

HTTP requests to the API are protected with HTTP Basic authentication. To learn more about how Allianz handles authentication, please refer to our Security Model page under Overview/Guidelines/Documentation.

Request Body Structure

FIELD REFERENCE - REquest

Field Description

Example

OriginatingSystem root element required
Contains details of the system sending request.
SystemVendorId string required
A code for the organisation. (logged).
SystemVendorName string required
Name of the organisation. (logged).
VendorProductName string required
The name of Organisation’s application. (logged)
VendorProductVersion string required
Used for versioning and allows mapping differences without needing to change namespaces.
Address root element optional
Any number of addresses. These are referenced from the insured and policy property. The link is made on the key.
LineOne string required (if Address element specified)
Represents the unstructured property and street level details of an address.
SuburbName string required (if Address element specified)
The suburb of the address.
StateOrProvinceName string required (if Address element specified)
The state of the address. Value passed should be a valid Postal Address Format (PAF)/Australia Post value.
PostalCode string required (if Address element specified)
The postal code of the address. Value passed should be a valid Postal Address Format (PAF)/Australia Post value.
CountryName string required (if Address element specified)
Name of the country (Australia)
Organisation root element optional
Contains details of the organisation sending request.
PolicyInsured root element optional
Any number of insured / co-insureds. Each may be a company or person.
Note: Allianz requires the ‘Primary’ insured to be the 1st insured person followed by the CoInsured. There is expected to be exactly one if a company is used
RoleCode string required (if PolicyInsured element specified)
Either “Insured” (primary) or “CoInsured”.
Note: Allianz will always expect the Insured (Primary) to be the 1st person in the xml
Person root element optional
Either a “Person” OR “Organisation” should be sent. (Not both)
Note: Organisation is currently not being used, companies that are the Insured must be entered as a primary insured person until further notice.
Telephone root element optional
Organisation/Person Telephone numbers, whichever is applicable.
PreferredFlag boolean required (if Telephone element specified)
Indicates if this address/Telephone is the preferred contact when multiple addresses/telephones are specified.
DoNotContactFlag boolean required (if Telephone element specified)
Indicates if this address/Telephone cannot be used as primary contact.
TypeCode string required (if Telephone element specified)
Type of the Phone number
Mobile/Home/Office.
PreferredContactTime string optional (if Telephone element specified)
Preferred contact time – always in 24hour format.
DayFlag boolean required (if Telephone element specified)
Indicates if customer can be contacted on daytime.
EveningFlag boolean required (if Telephone element specified)
Indicates if customer can be contacted on evening time.
PhoneNumber string required (if Telephone element specified)
Phone number.
Email root element optional
The email address of the customer/Organization whichever is applicable.
EmailAddress string required (if Email element specified)
The email address of the customer/Organization whichever is applicable.
MailingAddress root element optional
The address of the customer/Organization whichever is applicable.
LegalAddress root element optional
The address of the Organization if applicable.
PersonName root element optional
Person Details.
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/company.
MiddleName string required (if PersonName element specified)
The middle name of the customer.
AbbreviatedName string optional
The short name of the customer/organisation.
GenderCode string optional
Gender of the person.
BirthDate string optional
Birth date of the person.
CoverageInceptionDate string optional
The date that the insurance cover should commence, yyyy-MM-dd. Typically this is the settlement date of the purchase.
PolicyProperty root element optional
The details of the property or properties.
One policy property per property.
PurchasePriceAmount decimal optional
The value of the property (not the loan).
Structure string optional
Property type Eg: House, Unit, Semi.
PolicyIntermediary root element required
Details concerning who the lead is coming from.
PlacingOfficerUserId string required
Specific user id of the intermediary user.
PlacingOfficerCode string required
Identifier of the individual who placed the transaction in the Allianz sales system.
PlacingOfficerName string required
Full name of the individual who placed the transaction in the Allianz sales system.
IntermediaryId string required
Identifier of the partner in the Allianz sales system. To be provided to partner by Allianz.
Contact root element required
Contact details of the specific salesperson within the intermediary.
PolicyInterestedParty root element optional
Interested Party/ Financier aka Mortgagee.
LeadReferenceIdentifier root element optional
Intermediary’s Identifier of the loan application or lead
Id string optional
Intermediary’s Identifier of the loan application or lead.
LoanAmount Decimal optional
The total loan amount if available.
BuildingRequestedFlag boolean optional
An indication that building (owner) cover is desired.
ContentsRequestedFlag boolean optional
An indication that contents cover is desired.
LandlordRequestedFlag boolean optional
An indication that building (landlord) cover is desired.
MotorRequestedFlag boolean optional
An indication that motor cover is desired.
CaravanTrailerRequestedFlag boolean optional
An indication that Caravan Trailer cover is desired.
PreferredContactDate string optional
Preferred contact date.
LoanPurpose string optional
Purpose of the Loan.
Comments string optional
Comments/remarks if applicable.
Consent string required
Consent of the customer to be contacted via Allianz representative. This field is always “Yes”.

<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-472dbfc9-b561abac8d71</log:MessageId>
<log:CorrelationId>61debe47-b538-4a59-970a-66e967303fc8</log:CorrelationId>
<log:MessageDateTime>2017-03-20 16:28:19</log:MessageDateTime>
<log:BusinessId>123456789</log:BusinessId>
<log:UserId>User Id</log:UserId>
<log:ApplicationName>SYSTEM</log:ApplicationName>
</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-811c00155d7d1928</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>
</ns6:PolicyLeadDetails>
</PolicyLeadRequest>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope

Note: See Overview/Guidelines/Documentation section SOAP Request Headers for mandatory headers that must be supplied in addition to the above request.

FIELD REFERENCE - RESPONSE

Field Description	Example
MessageResult root element Message Result. StatusCode string Status of the response (success/failure).	<SOAP-ENV:Envelope> <SOAP-ENV:Body> <PolicyLeadResult> <NS1:MessageResult> <NS1:StatusCode>Success</NS1:StatusCode> </NS1:MessageResult> </PolicyLeadResult> </SOAP-ENV:Body> </SOAP-ENV:Envelope

ERROR ReSPONSE CODES

Refer to Overview/Guidelines/Documentation section SOAP Based Error Codes for details.

SPOT AND REFER9.0.0

Spot and Refer

About us

Documentation

API catalog

Contact

We are here to make insurance simple for you.