To create a quotation you need to make a POST call to the following url:
POST/v1/Quotation/Create
| Field | Type | Limit | Required | Description |
| request_type_code | string | 50 | Yes | Quotation request type: PROPERTY_INSURANCE |
| insurance_type_code | string | 50 | Yes | Insurance type: HOME_INSURANCE |
| voucher_code | string | 50 | Optional | Voucher or promo code |
| policy_no_previous | string | 50 | Optional | Previous policy number, if any |
| lang_code | string | 2 | Optional | Request language: en, ar. Default: en |
| async | boolean | - | Optional | true: create the quotation and return at once, read offers later. false: return the offers in the response |
| include_data | boolean | - | Optional | Response includes additional data |
| include_result | boolean | - | Optional | Response includes offers |
| client_type_id | int | - | Optional | Website: 1, Mobile: 2, Kiosk: 3 |
| collector_track_id | string | 50 | Optional | Your own unique reference for this request |
| reference_by_id | Int64 | - | Optional | Bima customer id when the customer is logged in; otherwise 0 |
| os | string | 50 | Optional | Device operating system name, version |
| browser | string | 50 | Optional | Device browser name, version |
| schedule |
Policy period
object
| Field | Type | Limit | Required | Description |
| policy_term_id | Int64 | - | Optional | Policy term; default: the product's term |
| date_from | string | 10 | Optional | Policy start date, dd/MM/yyyy. Default: today |
| date_to | string | 10 | Optional | Policy end date, dd/MM/yyyy. Default: one year from the start date |
|
| customer |
Customer
object
| Field | Type | Limit | Required | Description |
| country_code | string | 5 | Yes | Mobile dial code without +, e.g. 968 |
| national_no | string | 15 | Yes | Mobile number without the dial code. Oman: exactly 8 digits |
| contact_full_no | string | 20 | Yes | country_code + national_no, e.g. 96895542930 |
| area_code | string | 3 | Optional | Calculated from contact_full_no when empty |
| subscriber_code | string | 15 | Optional | Calculated from contact_full_no when empty |
| id_no | string | 20 | Yes | Customer civil / resident ID number |
| id_type | int | - | Yes | 1 = Person, 2 = Company |
| title_id | int | - | Optional | From the titles lookup |
| first_name | string | 25 | Optional | First name |
| middle_name | string | 25 | Optional | Middle name |
| last_name | string | 25 | Optional | Last name |
| email | string | 50 | Optional | Contact email |
| dob | string | 10 | Optional | Date of birth, dd/MM/yyyy |
| gender_id | int | - | Optional | 1 = Male, 2 = Female |
| nationality_country_id | int | - | Optional | From the nationalities lookup |
| region_id, city_id, town_id | Int64 | - | Optional | From the regions and cities lookup; otherwise 0 |
| pobox_no | string | 10 | Optional | P.O. Box number |
| address | string | 30 | Optional | Address |
| address2 | string | 30 | Optional | Address line 2 |
|
| home |
Home and contents
object
| Field | Type | Limit | Required | Description |
| property_type_id | int | - | Yes | Apartment: 1, Villa: 2 |
| property_ownership_type_id | int | - | Yes | Landlord: 1, Tenant: 2 |
| property_value | number | - | Yes | Value of the apartment / villa in OMR |
| residence_country_id | int | - | Optional | From the countries lookup |
| property_no | string | 20 | Optional | Apartment / villa number |
| building_name | string | 50 | Optional | Building name |
| marital_status_id | int | - | Optional | Single: 1, Married: 2, Widow: 3, Divorced: 4, Not applicable: 5 |
| occupation_id | int | - | Optional | From the occupations lookup |
| had_claims_in_previous_year | boolean | - | Optional | true / false |
| is_property_leased_for_short_period | boolean | - | Optional | true / false |
| un_occupancy_period_id | int | - | Optional | From the un-occupancy periods lookup |
|
| coverage_items |
Coverage items (contents, personal belongings)
array
| Field | Type | Limit | Required | Description |
| coverage_id | Int64 | - | Yes | Coverage id from the coverage and items lookup |
| id | Int64 | - | Optional | Selected value item id from the coverage and items lookup |
| amount_from | number | - | Optional | Value range from, in OMR |
| amount_to | number | - | Optional | Value range to, in OMR |
|
{
"request_type_code": "PROPERTY_INSURANCE",
"insurance_type_code": "HOME_INSURANCE",
"lang_code": null,
"voucher_code": "TEST123",
"policy_no_previous": "",
"reference_by_id": 0,
"customer": {
"id_no": "",
"id_type": 1,
"id_expire_date": "",
"license_no": "",
"country_code": "968",
"area_code": "95",
"subscriber_code": "542930",
"national_no": "",
"contact_full_no": "",
"title_id": 0,
"first_name": "NA",
"middle_name": "NA",
"last_name": "NA",
"email": "",
"nationality_country_id": 0,
"nationality_country_code": "",
"nationality_country_name": "",
"residence_country_id": 0,
"dob": "",
"passport_no": "",
"gender_id": 0,
"gender_name": "",
"region_id": 11,
"region_name": "",
"city_id": 57,
"city_name": "",
"town_id": 1,
"pobox_no": "",
"address": "",
"address2": ""
},
"os": "Windows",
"browser": "Chrome",
"collector_track_id": "",
"client_type_id": 2,
"async": true,
"schedule": {
"policy_term_id": 0,
"date_from": "",
"date_to": ""
},
"request_data": [],
"coverage_items": [
{
"coverage_id": 1,
"id": 1,
"amount_from": 1.0,
"amount_to": 7500.0
},
{
"coverage_id": 1,
"id": 2,
"amount_from": 0.0,
"amount_to": 0.0
},
{
"coverage_id": 2,
"id": 3,
"amount_from": 50000.0,
"amount_to": 50000.0
}
],
"home": {
"residence_country_id": 0,
"property_type_id": 1,
"property_ownership_type_id": 1,
"property_no": "",
"building_name": "",
"property_value": 50000.0,
"marital_status_id": 0,
"occupation_id": 0,
"had_claims_in_previous_year": false,
"is_property_leased_for_short_period": false,
"un_occupancy_period_id": 0
},
"business_activities": [],
"attributes_data": [],
"include_data": false,
"include_result": true
}