INDICATIVE QUOTE GET SUMMARY9.0.0

Indicative Quote Get Summary

Allianz hosts Indicative Quote Get Summary API to retrieve latest summary of an insurance quote that is already precedented via any of the above Indicative Quote APIs.

 

Business Use case

The Indicative Quote Get Summary API provides a capability to obtain the latest summary data of a quote. It must be preceded by either the:

  • Point of Sale initiated Indicative Quote or
  • Safety Net Initiated Indicative Quote

APIs as they will both issue an identifier, UUID for the quote. This identifier will be stored in the partner system if intending to inquire on status later. This identifier is used as input to Get Summary API.

 

Technical Overview

The Indicative Quote API is exposed via GET / getPolicySummary and uses REST based HTTP integration as transfer protocol.

The examples focus on the essential programming tasks for creating an Indicative Quote Summary Service, taking advantage of default settings when possible.

   GET safireServices/rest/v1/policy/summary?fi={intermediaryId}&token={tokenised_uuid}

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.

 

FIELD REFERENCE - REquest

Request fields for this API are not present as it uses GET as HTTP method. UUID is mandatory URL param to get quote summary.

 

FIELD REFERENCE - RESPONSE FOR PROPERTY

Field Description Example
  • policyHeader root element
    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 yyyyMM-dd. Typically this is the settlement date of the purchase. In the absence of a settlement date pass today’s date.
  • policyQuoteInformation root element
    Contains details of the officer initiating the request.
  • quoteNumber string required
    Identifier of the quote in the Allianz sales system.
  • quoteNumberPrefix string required
    prefix of the quote number in the Allianz sales system.
  • transactionInformation root element
    Contains details of the officer initiating the request.
  • contractStage string required
    Describes the stage of the issued quote.
  • processStatus string required
    Describes the status of the issued quote. Different process statues are detailed in Response Status Detail section.
  • policyNumberDetail root element
    Contains details of the policy.
  • companyCode string required
    Company Code specified for which insurance product has been issued.
  • branchCode string required
    Branch code of the product.
  • productCode string required
    Code or identifier of the product.
  • policyIntermediary root element
    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.
  • agentCode string required
    Batch ID/User ID from which the event has been triggered.
  • agentOfficerName string required
    Name of the event/User that has been triggered.
  • 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.
  • references root element
    Partner system’s Loan application number and customer number.
  • type string required
    Type of the number - Loan application 
    number/customer number/Submission ID.
  • value string required
    Value of the type given above.
  • policyInsureds root element
    Policy Insured contact details.
  • person root element
    Details of the customer.
  • organization root element
    Details of the organization if applicable.
  • 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).
  • mailingAddress root element
    Address of the person/organization.
  • lineOne string required
    Represents the unstructured property and street level details of an address.
  • suburbName string required
    The suburb of the address.
  • stateOrProvinceCode string required
    The state of the address. Value passed should be a valid Postal Address Format (PAF)/Australia Post value.
  • postalCode string required
    The postal code of the address. Value passed should be a valid Postal Address Format (PAF)/Australia Post value.
  • countryCode string required
    Code of the Country (AUS).
  • countryName string required
    Name of the country (Australia).
  • telephoneNumbers root element
    phone number of the person/organization.
  • typeCode string required
    Phone number type.
  • phoneAreaCode string required
    The area code of the phone number.
  • phoneCountryCode string required
    The country code of the phone number.
  • phoneNumber string required
    Phone number.
  • emailAddresses 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.
  • personName root element
    Name of the person/organization.
  • givenName string required 
    The first name of the customer/company.
  • surname string required
    The family name of the customer/company.
  • policyProperty root element
    Details of the property.
  • riskAdddress root element
    Communication address of the person/organization.
 {
"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_hEi1oZsEJhv
UY940hsRuKwZ8rLVlGActSnKFPM7owmYJvqcsc
8JhWxX3zfrijaQ"
}
],
"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"
}
}
}

 

FIELD REFERENCE - RESPONSE FOR VEHICLE

Field Description Example
  • policyHeader root element
    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.
  • policyQuoteInformation root element
    Contains details of the officer initiating the request.
  • quoteNumber string required
    Identifier of the quote in the Allianz sales system.
  • quoteNumberPrefix string required
    prefix of the quote number in the Allianz sales system
  • transactionInformation root element
    Contains details of the officer initiating the request.
  • contractStage string required
    Describes the stage of the issued quote.
  • processStatus string required
    Describes the status of the issued quote.
    Different process statues are detailed in Response Status Detail section.
  • policyNumberDetail root element
    Contains details of the policy.
  • companyCode string required
    Company Code specified for which insurance product has been issued.
  • branchCode string required
    Branch code of the product.
  • productCode string required
    Code or identifier of the product.
  • policyIntermediary root element
    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.
  • agentCode string required
    Batch ID/User ID from which the event has been triggered.
  • agentOfficerName string required
    Name of the event/User that has been triggered.
  • 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.
  • references root element
    Partner system’s Loan application number and customer number.
  • type string required
    Type of the number - Loan application number/customer number/Submission ID
  • value string required
    Value of the type given above.
  • policyInsureds root element
    Policy Insured contact details.
  • person root element
    Details of the customer.
  • organization root element
    Details of the organization if applicable.
  • 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).
  • mailingAddress root element
    Address of the person/organization.
  • lineOne string required
    Represents the unstructured property and street level details of an address.
  • suburbName string required
    The suburb of the address.
  • stateOrProvinceCode string required
    The state of the address. Value passed should be a valid Postal Address Format (PAF)/Australia Post value.
  • postalCode string required
    The postal code of the address. Value passed should be a valid Postal Address Format (PAF)/Australia Post value.
  • countryCode string required
    Code of the Country (AUS).
  • countryName string required
    Name of the country (Australia).
  • telephoneNumbers root element
    phone number of the person/organization.
  • typeCode string required
    Phone number type.
  • phoneAreaCode string required
    The area code of the phone number.
  • phoneCountryCode string required
    The country code of the phone number.
  • phoneNumber string required
    Phone number.
  • emailAddresses 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.
  • personName root element
    Name of the person/organization.
  • givenName string required 
    The first name of the customer/company.
  • surname string required
    The family name of the customer/company.
  • policyVehicle root element
    Details of the vehicle.
  • manufacturer root element
    Manufacture details of the vehicle
 {
<policy>
<policyHeader>
<insurancePeriodStartDate>2023-07-
14</insurancePeriodStartDate>
<policyIntermediary>
<agentCode>0000019</agentCode>
<agentName>TEACHERS MUTUAL BANK</agentName>
<branchCode>02</branchCode>
<intermediaryId>NSWTCUL</intermediaryI
d>
<placingOfficerCode>OUTBOUND</placingO
fficerCode>
<placingOfficerName>Jane 
Doe</placingOfficerName>
</policyIntermediary> 
<policyNumberDetail>
<branchCode>02</branchCode>
<companyCode>1</companyCode>
<productCode>CMP</productCode>
</policyNumberDetail>
<policyQuoteInformation>
<quoteNumber>332538</quoteNumber>
<quoteNumberPrefix>QS2</quoteNumberPre
fix>
<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_UbVDsDZH7QN94ss81XoLg
9qxYcL9bbtLmbOkofBG81ZbzQpNAKAwXWsHWI9
FhRpTirmGjL9aLRaW</value>
</references>
</references> 
<policyInsureds>
<policyInsureds>
<person>
<mailingAddress>
<countryCode>AUS</countryCode>
<countryName>AUSTRALIA</countryName>
<postalCode>2000</postalCode>
<stateOrProvinceCode>NSW</stateOrProvi
nceCode>
<suburbName>SYDNEY</suburbName>
</mailingAddress>
<telephoneNumbers>
<telephoneNumbers>
<phoneAreaCode>0456</phoneAreaCode>
<phoneNumber>123456</phoneNumber>
<typeCode>Mobile</typeCode>
</telephoneNumbers>
</telephoneNumbers>
<emailAddresses>
<emailAddresses>
<emailAddress>abc@def.com.au</emailAdd
ress>
<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</stateOrProvi
nceCode>
<suburbName>SYDNEY</suburbName>
</mailingAddress>
<telephoneNumbers>
<telephoneNumbers>
<phoneAreaCode>0456</phoneAreaCode>
<phoneNumber>56781234</phoneNumber>
<typeCode>Mobile</typeCode>
</telephoneNumbers>
</telephoneNumbers>
<emailAddresses>
<emailAddresses>
<emailAddress>def@def.com.au</emailAdd
ress>
<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</manufacturerN
ame>
<modelCode>EY905I</modelCode>
<modelName>MX-5</modelName>
<modelYear>2005</modelYear>
</manufacturer>
</vehicle>
</policyVehicle>
</policy>

 

FIELD REFERENCE - RESPONSE STATUS DETAIL

ProcessStatus  Sample Response
Complete string 
Quote has already been completed by the 
customer.		 "transactionInformation": { 
"contractStage": "Quote", 
"processStatus": "Complete"
}
Incomplete string
Quote has not been completed by the 
customer.		 "transactionInformation": { 
"contractStage": "Quote",
"processStatus": "Incomplete"
}
Declined string 
Quote has been declined.		 "transactionInformation": { 
"contractStage": "Quote",
"processStatus": "Declined"
}
ManualRatingAwaiting string 
Quote referral is raised.		 "transactionInformation": { 
"contractStage": "Quote",
"processStatus": "ManualRatingAwaiting"
 }

 

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.