Indicative Quote Rating Factors
This is a REST based API that fetches the facts, assumptions, premium details of the IQ POS.
Business Use case
The Indicative Quote Rating factor API provides a capability to obtain the latest summary data of a quote with the facts and the assumptions.
Facts are the data required for an Indicative quote price, for example: Building strata flag for property or Vehicle garaging postcode for Motor.
Assumptions are any data that are missing in the IQ request, that will be assumed by the API from a pre-set data called Assumptions for example if Vehicle use is missing from the request, the default value (assumption) is Private.
It must be preceded by either one of the following API calls:
- Point of Sale initiated Indicative Quote or
- Safety Net Initiated Indicative Quote
The above APIs will 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 IQ Rating factor API.
Technical Overview
The IQ Rating Factor API is exposed via GET / getIQRatingFactors and uses REST based HTTP integration as transfer protocol.
The examples focus on the essential programming tasks for creating an Indicative Quote Rating factor Service, taking advantage of default settings when possible.
GET safireServices/rest/v1/policy/iqratingfactors?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
| Example |
| { { "Quote estimate details": [ { "label": "Quote Estimate status", "code": "200", "value": "successful" }, { "label": "Estimate reference number", "value": "QS24917678" } ], "Assumptions": [ { "label": "Year Built", "value": "2008", "displayValue": "2008" }, { "label": "Claims / Losses in the last 5 years", "value": "0", "displayValue": "0" }, { "label": "Contents cover", "value": "75000", "displayValue": "$75000" }, { "label": "Domestic workers compensation", "value": "Not included", "displayValue": "Not included" }, { "label": "Accidental damage", "value": "Not included", "displayValue": "Not included" }, { "label": "Building cover", "value": "447718", "displayValue": "$447718" }, { "label": "Type of Building", "value": "House on Slab/Foundations", "displayValue": "House on Slab/Foundations" }, { "label": "Exterior walls", "value": "Brick Veneer", "displayValue": "Brick Veneer" }, { "label": "Flood cover", "value": "Included", "displayValue": "Included" }, { "label": "Motor burnout", "value": "Not included", "displayValue": "Not included" }, { "label": "Portable contents", "value": "Not included", "displayValue": "Not included" }, { "label": "Product type", "value": "Home Insurance", "displayValue": "Home Insurance" }, { "label": "Roof type", "value": "Concrete Tiles", "displayValue": "Concrete Tiles" }, { "label": "Security device/s", "value": "Back to base alarm", "displayValue": "Back to base alarm" }, { "label": "Site exceeds 20,000 square meters", "value": "No", "displayValue": "No" }, { "label": "Swimming pool", "value": "No", "displayValue": "No" } ], "Facts": [ { "label": "Risk address", "value": "5 BELLA VISTA CRS, PAKENHAM VIC 3810", "displayValue": "5 BELLA VISTA CRS, PAKENHAM VIC 3810" }, { "label": "Basic Excess", "value": "1000", "displayValue": "$1000 (Other excesses may apply)" }, { "label": "Date of Birth", "value": "1980-01-02", "displayValue": "1980-01-02" }, { "label": "Placing officer code", "value": "NABPE001", "displayValue": "NABPE001" }, { "label": "Policy Start Date", "value": "2023-11-08", "displayValue": "2023-11-08" }, { "label": "Date of Quote", "value": "2023-11-08", "displayValue": "2023-11-08" }, { "label": "Occupancy", "value": "Owner occupied", "displayValue": "Owner occupied" }, { "label": "Full Name", "value": "John Smith", "displayValue": "John Smith" }, { "label": "Part of strata or company Title plan", "value": "No", "displayValue": "No" } ], "Premium details": [ { "label": "Gross Premium (Yearly)", "value": "1635.66", "displayValue": "$1635.66" }, { "label": "Monthly premium", "value": "136.31", "displayValue": "$136.31" } ] } |
List of reference data
- Type of Building
{Key=H, Value=House on Slab/Foundations},
{Key=D, Value=House on Poles},
{Key=U, Value=Flat/Unit},
{Key=S, Value=Terrace/Semi},
{Key=T, Value=Villa/Town House},
{Key=V, Value=Retirement Village Unit},
{Key=L, Value=Holiday Home},
{Key=R, Value=Relocatable Home},
{Key=G, Value=Granny Flat},
{Key=C, Value=Caravan},
{Key=M, Value=Mobile Home},
{Key=N, Value=Nursing Home Unit},
{Key=B, Value=Under Construction},
{Key=O, Value=Other} - Exterior walls
{Key=D, Value=Double brick},
{Key=V, Value=Brick Veneer},
{Key=T, Value=Timber/Weatherboard},
{Key=E, Value=Steel},
{Key=C, Value=Concrete/Hebel},
{Key=F, Value=Fibro/Asbestos cement},
{Key=Z, Value=Stone/Sandstone},
{Key=P, Value=Polystyrene},
{Key=M, Value=Mud brick},
{Key=O, Value=Other construction} - Roof type
{Key=C, Value=Concrete Tiles},
{Key=F, Value=Fibro},
{Key=M, Value=Metal/Iron/Colourbond},
{Key=S, Value=Slate},
{Key=T, Value=Tile},
{Key=P, Value=Copper},
{Key=R, Value=Tin (other than Metal/Iron/Colourbond)},
{Key=I, Value=Shingle},
{Key=H, Value=Thatched},
{Key=O, Value=Other} - Employment status
{Key=FT, Value=Full time},
{Key=PT, Value=Part time / Casual},
{Key=UN, Value=Unemployed},
{Key=RT, Value=Retired},
{Key=ST, Value=Student},
{Key=SE, Value=Self employed},
{Key=HD, Value=Home duties} - Finance
{Key=X, Value=No Finance},
{Key=B, Value=Bank Loan (Secured)},
{Key=O, Value=Bill of Sale},
{Key=C, Value=Corporate Hire Purchase},
{Key=U, Value=Credit Union (Secured)},
{Key=F, Value=Finance Co (Secured)},
{Key=H, Value=Hire Purchase},
{Key=E, Value=Home Equity Loan},
{Key=L, Value=Lease},
{Key=N, Value=Novated Lease},
{Key=P, Value=Personal Loan (Secured)},
{Key=S, Value=Personal Loan (Unsecured)} - Residential Status
{Key=O, Value=Owner},
{Key=R, Value=Renter},
{Key=U, Value=Other} - Garaging
{Key=C, Value=Carport},
{Key=D, Value=Parked off street in driveway},
{Key=G, Value=Garage},
{Key=S, Value=Parked on street}
FIELD REFERENCE - RESPONSE FOR VEHICLE
| Example |
| { "Quote estimate details": [ { "label": "Quote Estimate status", "code": "200", "value": "successful" }, { "label": "Estimate reference number", "value": "QS2168452" } ], "Assumptions": [ { "label": "Vehicle Use", "value": "P", "displayValue": "Private" }, { "label": "Finance", "value": "Auto", "displayValue": "Auto" }, { "label": "Will anyone Under25 drive this vehicle?", "value": "No", "displayValue": "No" }, { "label": "Already Insurance", "value": "Yes", "displayValue": "Yes" }, { "label": "Claims", "value": "0", "displayValue": "0" }, { "label": "Vehicle Owner", "value": "2008", "displayValue": "2008" }, { "label": "Owner of another vehicle", "value": "No", "displayValue": "No" }, { "label": "Vehicle Accessories, Modifications", "value": "None", "displayValue": "None" }, { "label": "Annual distance travelled in kilometres", "value": "10000-15000", "displayValue": "10,000-15,000 kms" }, { "label": "Employment status", "value": "Full-time", "displayValue": "Full-time" }, { "label": "Residential status", "value": "Owner", "displayValue": "Owner" }, { "label": "Garaging Type", "value": "Garage", "displayValue": "Garage" }, { "label": "Security", "value": "Standard", "displayValue": "Standard" }, { "label": "Licence age", "value": "18", "displayValue": "18" }, { "label": "Cover type", "value": "Market Value", "displayValue": "Market Value" }, { "label": "Basic Excess", "value": "600", "displayValue": "$600" }, { "label": "Options No excess for tyre", "value": "No", "displayValue": "No" }, { "label": "Options No excess for windscreen", "value": "No", "displayValue": "No" }, { "label": "Options staying mobile following an accident", "value": "No", "displayValue": "No" }, { "label": " Options Tools of trades", "value": "No", "displayValue": "No" }, { "label": " Options No claim bonus", "value": "No", "displayValue": "No" }, { "label": "Options Rental car following the accident", "value": "No", "displayValue": "No" }, { "label": " Options Roadside assistance", "value": "No", "displayValue": "No" }, { "label": "Options Nil excess on windscreen", "value": "No", "displayValue": "No" }, { "label": " Policy Type", "value": "Comprehensive", "displayValue": "No" }, { "label": "Claims", "value": "No", "displayValue": "No" } ], "Facts": [ { "label": "Date of Birth", "value": "1980-01-01", "displayValue": "1980-01-01" }, { "label": "Garaging Address", "value": "Suburb, postcode (or full address)", "displayValue": "Suburb, postcode (or full address)" }, { "label": "Registration", "value": "A1234" , "displayValue": "A1234" }, { "label": "Policy Start Date", "value": "06/09/2023", "displayValue": "06/09/2023" }, { "label": "Driver gender", "value": "Male", "displayValue": "Male" } ], "Premium details": [ { "label": "Gross Premium (Yearly)", "value": "1684.41", "displayValue": "$1684.41" }, { "label": "Monthly premium", "value": "$140.38", "displayValue": "$140.38" }, ] } |
FIELD REFERENCE - ERROR SAMPLE RESPONSE
| Example |
| { "Quote estimate details": [ { "label": "Quote Estimate status", "value": "400" "code": "INVALID_QUOTE_NUMBER", "description": "We cannot process using this quote number, please check IQ quote number." }, { "label": "Estimate reference number", "value": "QS2168452" } ] } |
FIELD REFERENCE - RESPONSE STATUS DETAIL
| Quote estimate details |
This has the following:
|
In case of successful response, the quote estimate status says ‘successful’, in case of error response, status says “INVALID_QUOTE_NUMBER: we cannot process using this quote number, please check IQ quote number.” |
| Assumptions |
Any data that was not sent in the original IQ API request of
Then a default value is assumed. |
For all the default values in Property, please refer to the section: 3.1.2.4 (update needed) For all the default values in Vehicle, please refer to the section: 3.1.2.5 (update needed) |
| Facts | For all the data sent in the original request, the minimum required data for an indicative quote |
For all the required values in Property, please refer to the section: 3.1.2.4 (update needed) |
| Premium details |
This contains the Quote estimate premium breakdown:
|
Only for successful response |
ERROR ReSPONSE CODES
Refer to Overview/Guidelines/Documentation section REST Based Error Codes for details.
