Request body structure for motor products
Field reference – request for vehicle
Sample request
{ "policyHeader": { "brand": { "code": "MER" }, "insurancePeriodStartDate": "2024-10-29", "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" }, "mailingAddressSameAsGaragingAddress": false, "personName": { "givenName": "mjaydxlwif", "surname": "npsoudreqk", "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" }, "mailingAddressSameAsGaragingAddress": 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": { "vehicleIdentificationNumber": "" }, "redBookCode": "LEXU21BV", "vehicleBody": { "code": "2D CONVERTIBLE" } }, "references": [ { "type": "EXTERNAL_SYSTEM", "value": "PARTNER_SYSTEM_A" }, { "type": "EXTERNAL_SYSTEM_ID", "value": "ad1d21ea-a017-41e6-9b38-eba159288b32" }, { "type": "DMS_DEAL_NUM", "value": "DMS123456789" }, { "type": "CUST_NUM", "value": "C123456789" }, { "type": "DISCOUNT_CODE", "value": "CH" } ] } }
| Request Field | Field Type | Status | Description |
|---|---|---|---|
| policyHeader | Root element | Required | Contains policy details such as policy start date and name of the initiating officer. |
| brand | Root element | Required | This refers to the brand of vehicle as identified below. |
| code | Required |
These are the three letters that indicate the car brand. For example: MER, MINI, BMW, VOL. The Allianz brand code is always AAL. |
|
| insurancePeriodStartDate | String | Required |
The insurance start date. This should be in the format yyyy-MM-dd. Typically, this is the settlement date of the purchase. If there's no settlement date, use today’s date instead. |
| policyIntermediary | String | Required | Contains details of the officer initiating the request. |
| intermediaryId | String | Required | Identifies your company within our sales system. Your account manager will provide this to you. |
| placingOfficerCode | String | Required | Identifies the person who entered the transaction into our sales system. |
| placingOfficerName | String | Required | Full name of the person who entered the transaction into our sales system. |
| placingOfficerEmail | String | Optional | Email of the person who entered the transaction into our sales system. |
| policyInsureds | Root element | Required | Contact details of the policy holder. |
| type | String | Required |
This section represents the entities (either a person or company) to be insured on the quote. Only one entity in the list can be designated as PRIMARY, which can either be a person or company. Additional entities can be identified as COINSURED, but they must be individuals. The list can contain a maximum of five entities: one PRIMARY (person or company) and up to four COINSURED (individuals). |
| person | Root element | Required | Details of the insured policyholder. |
| emailAddresses | Root element | Required | The email addresses of the person or company, whichever is applicable. |
| emailAddress | String | Required | The email address of the person or company, whichever is applicable. |
| preferred | Boolean | Required | Indicates the preferred email address when multiple email addresses are provided. |
| mailingAddress | Root element | Optional | Postal address of the person or company. |
| countryCode | String | Optional | Code of the country (AUS). |
| countryName | String | Optional | Name of the country (Australia). |
| lineOne | String | Optional | Describes the unstructured details of a property, including street-level information. |
| postalCode | String | Optional | The four digit postcode of the address. This should be provided in a valid Postal Address Format (PAF) or as an Australia Post value. |
| stateOrProvinceCode | String | Optional | 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. |
| suburbName | String | Required | The suburb where the address is located. |
| personName | Root element | Required | The customer's details as listed below. |
| givenName | String | Required | The first name of the person. |
| surname | String | Required | The family name of the person. |
| telephoneNumbers | Root element | Optional | Telephone numbers for the person or company, whichever is applicable. |
| phoneAreaCode | String | Optional | The area code of the phone number. |
| phoneCountryCode | String | Optional | The country code of the phone number. |
| phoneNumber | String | Optional | This is the eight digits of a landline, or last six digits of a mobile number. |
| typeCode | String | Optional | This indicates if it's a mobile or landline number. |
| type | String | At least one required (primary) |
This section represents the entities (either a person or company) to be insured on the quote. Only one entity in the list can be designated as PRIMARY, which can either be a person or company. Additional entities can be identified as COINSURED, but they must be individuals. The list can contain a maximum of five entities: one PRIMARY (person or company) and up to four COINSURED (individuals). |
| policyVehicle | Root element | Required | The details of the vehicle as listed below. |
| garagingAddress | String | Required | The garaging address of the vehicle. |
| countryCode | String | Required | Code of the country (AUS). |
| countryName | String | Required | Name of the country (Australia). |
| lineOne | String | Required | Describes the unstructured details of a property, including street-level information. |
| postalCode | String | Required | The four digit postcode of the address. This should be provided in a valid Postal Address Format (PAF) or as an Australia Post value. |
| stateOrProvinceCode | String | Required | 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. |
| suburbName | String | Required | The suburb where the address is located. |
| vehicleRiskCriteria | Root element | Optional | The vehicle’s cover type as listed below. |
| financeMethodCode | String | Optional | See the full list of vehicle finance codes on the overview page. |
| employmentStatus | String | Optional | See the full list of employment status codes on the overview page. |
| residentialStatus | String | Optional | See the full list of residential status codes on the overview page. |
| coverType | String | Optional | The vehicle’s market value or agreed value. |
| policyDriver | Root element | Required | The primary policyholder driver details. |
| givenName | String | Required | The policyholder's first name. |
| surName | String | Required | The policyholder's family name. |
| genderCode | String | Required |
The policyholder’s gender, which can be displayed as either:
|
| birthDate | String | Required |
The policyholder’s date of birth. This should follow the format: yyyy or mm-yyyy |
| vehicleOwnerFlag | String | Optional |
This flag indicates the primary driver when multiple drivers are listed on the policy. Value: true/false |
| underTwentyFiveFlag | String | Optional |
This flag indicates if there are any drivers under 25 years. Value: true/false |
| ownOtherVehicleFlag | String | Optional |
This flag indicates whether the policy holder owns another vehicle. Value: true/false |
| licenceAge | String | Optional | Age of the driver listed on the policy. |
| numberOfClaims | String | Optional |
This indicates the number of claims made by the policyholder in the past five years. Displayed as 0, 1, 2. |
| claimsHistory | Root element | Optional | This captures the claims history details of the policyholder |
| claimsYear | String | Optional | The year of the at-fault vehicle claim. The dropdown in quote process will display the current year followed by previous five years. |
| vehicleUse | Root element | Required | The intended use of the vehicle, this could be for business, ride share or personal use. |
| Code | String | Optional | See the full list of codes on the overview page. |
| garageCode | String | Optional | See the full list of garage codes on the overview page. |
| estimatedAnnualDistance | String | Optional | See the full list of estimated annual distance codes on the overview page. |
| registration | Root element | One is required |
The vehicle’s registration details. At least one of the below is required:
|
| registrationId | String | Optional if NVIC, RedBook code, or VIN is provided | The vehicle’s number plate. |
| Nvic | String | Optional if registration ID, RedBook code, or VIN is provided | Glass's National Vehicle Identification Code (NVIC) is a unique character code used to identify an individual vehicle. This value is only available to Glass's customers. |
| redBookCode | String | Optional if registration ID, NVIC, or VIN is provided. | The RedBook code consists of eight characters (e.g. HOLD04AN) and is unique to the vehicle throughout its life. |
| vehicleBody | Root element | Optional | This refers to the vehicle’s body design (e.g. sedan, SUV or hatchback). |
| Code | Root element | Optional | Details of vehicle shape, engine etc. |
| Chassis | String | Optional | The chassis details such as if it’s a ladder frame, monocoque or space frame. |
| vehicleIdentificationNumber | String | Optional if registration ID, NVIC or RedBook code is provided | The vehicle identification number (VIN) consists of 17 characters to identify a vehicle and, in some cases, keep track of its service history. |
| references | String | Optional | This helps further identify the vehicle within your own log. For example, deal numbers, discount codes or customer numbers. |
Sample request
Access the full list of mandatory REST request headers on the getting started page.
