INDICATIVE QUOTE POS9.0.1

 

 

Indicative Quote Point Of Sale (POS)

This API is REST based to provide insurance quote based on customer data sent by partners.

 

Business Use case

This API presents an Indicative quote of Insurance for a customer when basic information is provided. Partner system to push data to Allianz to create an insurance policy estimate. Customer, property, and finance data can be pushed to Allianz to form a policy.

 

Technical Overview

The Indicative Quote API is exposed via 

        PUT/createPolicyEstimate 

and uses REST based HTTP integration as transfer protocol. The examples focus on the essential programming tasks for creating an Indicative Quote POS, taking advantage of default settings when possible.

   PUT v1/policy/estimate/{product}

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 for Property

 

Request body structure for Motor (Vehicle)

 

Field Reference – Request for Property

Field Description Example
  • policyHeader root element required Contains policy details such as policy start date, name of the officer initiating etc.
  • insurancePeriodStartDate string required Start date of the insurance in the format yyyy-MM-dd. Typically this is the settlement date of the purchase. In the absence of a settlement date pass today’s date.
  • policyIntermediary root element required Contains details of the officer initiating the request.
  • intermediaryId string required Identifier of the partner in the Allianz sales system. To be provided to partner by Allianz.
  • 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.
  • placingOfficerEmployeeID string optional Employee ID of the individual who placed the transaction in the Allianz sales system.
  • placingOfficerEmail string optional Email of the individual who placed the transaction in the Allianz sales system.
  • policyInsureds root element required Policy Insured contact details.
  • person root element required (if individual/private request) Details of the customer.
  • organization root element required (if group/ organization request) Details of the organization if applicable.
  • emailAddresses string required (if Indicative Quote Safetynet API) The email address of the customer/Organization whichever is applicable.
  • emailAddress string required The email address of the customer/Organization whichever is applicable.
  • preferred boolean required Indicates if this email address is the preferred contact when multiple email address is specified.
  • mailingAddress root element optional Organisation/Person Address.
  • countryCode string required Code of the Country (AUS).
  • countryName string required Name of the country (Australia).
  • lineOne string required Represents the unstructured property and street level details of an address.
  • postalCode string required The postal code of the address. Value passed should be a valid Postal Address Format (PAF)/Australia Post value.
  • stateOrProvinceCode string required The state of the address. Value passed should be a valid Postal Address Format (PAF)/Australia Post value.
  • suburbName string required The suburb of the address.
  • personName root element required Person Details.
  • givenName string required The first name of the customer/company.
  • surname string required The family name of the customer/company.
  • telephoneNumbers root element optional Organisation/Person Telephone numbers, whichever is applicable.
  • phoneAreaCode string optional The area code of the phone number.
  • phoneCountryCode string required The country code of the phone number.
  • phoneNumber string required Phone number.
  • typeCode string required Phone number.
  • type string required Represents the entities (Person or Company) to be insured on the quote. Only one PolicyInsured in the List can have a type=PRIMARY. This can be either a Person or a Company. Additional PolicyInsured can be specified in the List but must be a Person and have type=COINSURED. Maximum number of PolicyInsured in the List is 5 i.e., 1 PRIMARY (Person or Company) and 4 COINSURED (Person).
  • policyProperty root element required Details of the property.
  • buildingSumInsured string optional An actual building valuation. In the absence of a customer confirmed building sum insured either a) a building valuation OR b) an estimated building valuation can be provided. In the case of b) an estimated building valuation can be given as a % of the security property (combined building and land) valuation. % to be calculated in the partner system. Allianz and partner to discuss exact % during API on-boarding. The value must be a whole number without formatting i.e. no commas or decimals are allowed e.g.660000 Allowed 660000.66 Not
    allowed 660,000 Not Allowed.
  • buildingValuation string optional An estimated building valuation. In the absence of a customer confirmed building sum insured either a) a building valuation OR b) an estimated building valuation can be provided. In the case of b) an estimated building valuation can be given as a % of the security property (combined building and land) valuation. % to be calculated in the partner system. Allianz and partner to discuss exact % during API on-boarding. The value must be a whole number without formatting i.e. no commas or decimals are allowed e.g.660000 Allowed 660000.66 Not allowed 660,000 Not Allowed.
  • contentsSumInsured string optional Actual contents of Sum Insured.
  • homeLoanApplication boolean required Is this quote part of a home loan process?.
  • loanPurpose string optional Purpose of the loan on the property.
  • occupancy root element required Occupancy details of the property.
  • occupancyType string required Purpose of the loan on the property. Accepted values for this field are Owner and landlord.
  • oldestOccupantDateOfBirth string required Oldest Occupant DoB 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/organization.
  • strataTitleFlag boolean required States whether the property is under strata title.
  • references root element required Partner system’s Loan application number and customer number.
  • type string required Type of the number - Loan application number/customer number/Discount code. Customer number is always mandatory.
  • value string required Value of the type given above.
 
{
	"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"
		}
	]
}

 

Field Reference – Request for Vehicle

Example Node Required/Optional Description

{
"policyHeader": {
"brand": {
"code": "MER"
},

"insurancePeriodStartDate":  "2024-05-22",
"policyIntermediary": {

 "intermediaryId": "MERBEBFREE",
"placingOfficerCode":  "OUTBOUND",
"placingOfficerName": 
"Jane Doe”,

"placingOfficerEmail": 
"jane.doe@gmail.com"
}
},
"policyInsureds": [
{
"type": "PRIMARY",
"person": {
"emailAddresses": [
{
"emailAddress": 
"abc@def.com.au",
"preferred": 
"true"
}
],
"mailingAddress": {
"countryCode": 
"AUS",
"countryName": 
"AUSTRALIA",
"lineOneDetails": 
{

"addressNumber": "10",

"addressNumberCode": "NO",
"propertyName": 
"Chateau Relaxo",
"streetName": 
"GEORGE",

"streetTypeCode": "ST",

"subdwellingCode": "U",

"subdwellingLevel": "5",

"subdwellingNumber": "200"
},
"postalCode": 
"2000",

"stateOrProvinceCode": 
"NSW",
"suburbName": 
"SYDNEY"
},

"mailingAddressSameAsGaragi
ngAddress": "false",
"personName": {
"givenName": 
"John",
"surname": 
"Smith",
"personTitle": 
"MR"
},
"telephoneNumbers": 
[
{

"phoneAreaCode": "0456",

"phoneCountryCode": "+61",
"phoneNumber": 
"123456",
"typeCode": 
"Mobile"
}
]
}
},
{
"type": "COINSURED",
"person": { 

"emailAddresses": [
{
"emailAddress": 
"def@def.com.au",
"preferred": 
"true"
}
],
"mailingAddress": {
"countryCode": 
"AUS",
"countryName": 
"AUSTRALIA",
"lineOneDetails": 
{

"addressNumber": "10",

"addressNumberCode": "NO",
"propertyName": 
"Chateau Relaxo",
"streetName": 
"GEORGE",

"streetTypeCode": "ST",

"subdwellingCode": "U",

"subdwellingLevel": "5",

"subdwellingNumber": "200"
},
"postalCode": 
"2000",

"stateOrProvinceCode": 
"NSW",
"suburbName": 
"SYDNEY"
},

"mailingAddressSameAsGaragi
ngAddress": "false",
"personName": {

"givenName": 
"Jane",
"surname": 
"Smith"
},
"telephoneNumbers": 
[
{

"phoneAreaCode": "0456",

"phoneCountryCode": "+61",
"phoneNumber": 
"56781234",
"typeCode": 
"Mobile"
}
]
}
}
],
"policyVehicle": {
"garagingAddress": {
"countryCode": "AUS",
"countryName": 
"AUSTRALIA",
"lineOne": "5 Bella 
Vista Crescent",
"postalCode": 3810,

"stateOrProvinceCode": 
"VIC",
"suburbName": 
"Pakenham"
},
"vehicleRiskCriteria": 
{
"financeMethodCode": 
"L",
"employmentStatus": 
"FT",
"residentialStatus": 
"O",

"covertype": 
"MarketValue"
},
"policyDriver": {
"genderCode": "Male",
"birthDate": "1977-
04-23",
"vehicleOwner": 
"true",

"underTwentyFiveFlag": 
"true",

"ownOtherVehicleFlag": 
"true",
"licenceAge": "18",
"numberOfClaims": "",
"claimsHistory": [
{
"claimYear": 
"2023",
"claimType": "AF"
}
]
},
"vehicleUse": {
"code": "P",
"garageCode": "G",

"estimatedAnnualDistance": 
"1"
},
"vehicle": {
"nvic": "",
"registration": {
"registrationId": 
"MX542"
},
"chassis": {

"vehicleIdentificationNumbe
r": ""
}, 

"redBookCode": 
"LEXU21BV",
"vehicleBody": {
"code": "2D 
CONVERTIBLE"
}
}
},
"references": [
{
"type": 
"EXTERNAL_SYSTEM",
"value": 
"PARTNER_SYSTEM_A"
},
{
"type": 
"EXTERNAL_SYSTEM_ID",
"value": "ad1d21eaa017-41e6-9b38-
eba159288b32"
},
{
"type": 
"DMS_DEAL_NUM",
"value": 
"DMS123456789"
},
{
"type": "CUST_NUM",
"value": "C123456789"
}
]
} 

 policyHeader required  Root element
Contains policy details such as policy start date, name of the officer initiating etc.
brand  required  Root element
code  required  Required field for Dealer Motor, 3 letters of the the brand of the car.
Example: MER, MIN, BMW, VOL
insurancePeriodStar
tDate		 required String
Start date of the insurance in the format yyyy-MM-dd. 
Typically this is the settlement date of the purchase. In the absence of a settlement date pass today’s date.
policyIntermediary  required  Contains details of the officer initiating the request.
intermediaryId  required  Identifier of the partner in the Allianz sales system. To be provided to partner by Allianz.
placingOfficerCode  required  Identifier of the individual who placed the transaction in the Allianz sales system. 

placingOfficerName 		 required  Full name of the individual who placed the transaction in the Allianz sales system.
placingOfficerEmail optional  Email of the individual who placed the transaction in the Allianz sales system. 
policyInsureds required
Policy Insured contact details 
person optional  Details of the customer
emailAddresses  required  If Indicative quote Safetynet API.
The email address of the customer.
emailAddress  required  If Indicative quote Safetynet API.
The email address of the customer
preferred required  Boolean
Indicates if this email address is the preferred contact when multiple email address is specified. 
mailingAddress optional  Person Address
countryCode  optional  Code of the Country (AUS)
countryName optional Name of the country (Australia). 
lineOne optional  Represents street level details on the Insured mailing Address.
postalCode optional The postal code of the address.
Value passed should be a valid Postal Address Format (PAF)/Australia Post value. 
stateOrProvinceCode optional The state of the address.
Value passed should be a valid Postal Address Format (PAF)/Australia Post value. 
suburbName  optional The suburb of the address. 
personName required Person Details. 
givenName  required  The first name of the customer
surname required The family name of the customer
telephoneNumbers optional Person Telephone numbers, whichever is applicable. 
phoneAreaCode  optional  The area code of the phone number.
phoneCountryCode  required  The country code of the phone number.
phoneNumber  required  Phone number
typeCode  required  Type of phone
Mobile/landline
type  required  Represents the entities (Person) to be insured on 
the quote. Only one PolicyInsured in the List can have a type=PRIMARY. 
Additional PolicyInsured can be specified in the List but must be a Person and have type=COINSURED. 
Maximum number of PolicyInsured in the List is 5 i.e., 1 PRIMARY (Person) and 4 COINSURED (Person).
policyVehicle  required  Details of the Vehicle
garagingAddress  required  Details of the Garaging Address of the Vehicle
countryCode  required  Code of the Country (AUS)
countryName required Name of the country (Australia). 
lineOne optional  Represents street level details on the Insured mailing Address.
postalCode optional The postal code of the address.
Value passed should be a valid Postal Address Format (PAF)/Australia Post value. 
stateOrProvinceCode required The state of the address.
Value passed should be a valid Postal Address Format (PAF)/Australia Post value. 
suburbName  optional The suburb of the address. 
vehicleRiskCriteria optional Root element
Vehicle cover type
financeMethodCode  optional 

How is your vehicle financed?

Value Description
X No Finance
B Bank Loan
O Bill of Sale
C Corporate Hire Purchase
U Credit Union (Secured)
F Finance Co (Secured)
H Hire Purchase
E Home Equity Loan
L Lease
N Novated Lease
P Personal Loan (Secured)
S Personal Loan (Unsecured)
employmentStatus  optional 

What is your current employment status? 

Value Description
FT Full time
PT Part time
UN Unemployed
RT Retired
ST Student
SE Self employed
HD Home duties
residentialStatus  optional 

What is your current residential status? 

Value Description
O Owner
R Renter
U Other
coverType  optional  Market Value
Or
Agreed Value
policyDriver  required  Primary Policy Driver details
givenName  required  Policy holder’s first name
surName  required  Policy holder’s last name
genderCode  optional  Policy holder’s gender
Male
Female
Other
birthDate  required  Policy holder date of birth, not full but following format :
yyyy or mm-yyyy
vehicleOwnerFlag  optional  This flag indicates that this PolicyDriver is primary, in case of more than one PolicyDriver.
Value : true/false
underTwentyFiveFlag  optional  This flag indicates if there are any drivers Under 25 years old.
Value: true/false
ownOtherVehicleFlag  optional  This flag indicates whether the Policy holder owns any other vehicle.
Value : true/false
imposedExcess  optional  Not required
licenceAge  optional  Age of the policydriver.
numberOfClaims  optional 

Year: Dropdown will show last 6 years (i.e current year followed by remaining 5 years) and Accident / Claim type

Value Description
AN Damage caused by an animal
AR Fire (not Arson)
CO Collision or damage - not at fault
MD Vandalism or Arson
SH Storm or hail damage
TA Theft of accessories from the car
WD Windscreen damage to a vehicle
AF Collision or damage - at fault
DK Parked damage - responsible party identified
DU Parked damage - responsible party unidentified
TC Theft of car
vehicleUse  required  Vehicle usage root element 
Code  required
Value Description
P Private use
R Ride share
B Business use
garageCode  required 

Type of garaging of the vehicle:

Value Description
C Carport
D Parked off the street in the Driveway
G Garage
S Parked on the street
estimatedAnnualDist
ance		 required 

Approximately how many kilometres per year does your vehicle travel?

Value  Description
1  Up to 10,000 km
2  10,000 – 15,001 km
3  15,001 – 20,000 km
4  >20,000 km
registration  required  Registration details of the vehicle. (root element)
One of the registration details are Required. Either registrationId/Nvic/redbookcode/VIN.

registrationId 		 optional  String
Plate number of the vehicle
Nvic  optional  String
Glass's National Vehicle Identification Code (NVIC) is a unique character code used to identify an individual motor vehicle. 
This value is only available to Glass's customers.
redBookCode  optional  The Red Book Code, which consists of eight digits, (HOLD04AN), is unique to the particular vehicle and remains with that vehicle throughout its life. It's the basis to the Red Book information system and everything that flows from it.
vehicleBody  optional  Root element. 
Vehicle Body details.
Code  optional  Details of the vehicle 
shape, engine etc
Chassis  optional  Chassis details
vehicleidentificationNumber optional  VIN number of the vehicle

 

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

 

Field Reference – ReSPONSE

   
  • type string required
    Type of link.
  • uri string required
    URI link back to the estimate in the Allianz sales system. This estimate 
    contains information confirmed by the customer and assumptions applied by Allianz. This is the link that allows the consultant to retrieve, view, and action the estimate in the Allianz sales system. 
    For every estimate there is an associated quote. See uuid below on how to obtain summary information of the quote.
  • uuid string required
    The uuid is a non-expiring encrypted 
    token uniquely identifying the quote in the Allianz sales system. This quote only contains information that has been confirmed by the customer i.e. it does not contain any assumptions. This uuid can be stored in the partner system and used to query the status of the quote by using the API service.
 {
"type": "DocumentLink",
"uuid": 
"QS2124536_aZ_rNpDypDJ3Ude51XrrdLuqZ5xHzGvInYbc_VkWu8hJ7tgLeovGEmg",
"uri": 
"https://www.einsure.com.au/DSPauth/personal/web/policy/estimate?fx=YXVz…"
}

 

ERROR ReSPONSE CODES

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

About us

We build custom-fit developer portals in Drupal, a proven enterprise-ready technology with a large consultant and developer community.

Documentation

Concepts
Getting started
Tutorials
Rerefence Documentation

API catalog

Category 1

Category 2

Category 3

Category for hover

Contact

Get in touch.
noreply.apis@allianz.com
dp-noprod-australia.apis.allianz.com
bottom_navigation_image

We are here to make insurance simple for you.