Bima Bima API Docs v1

Travel Insurance

Insurance for one trip and up to 10 travellers, for travellers leaving Oman (outbound) or visitors coming to Oman (inbound). Benefits and limits differ per insurer and are returned with each offer.

request_type_code TRAVEL_INSURANCE
insurance_type_code TRAVEL_OUTBOUND TRAVEL_INBOUND
Pricing Synchronous (async: false): offers come back with Create
Before Submit Update travellers (names, passports, gender)

Create Quotation

Prices one trip for up to 10 travellers. With async: false the response already carries the offers; if it still says Processing, read the offers again. To create a quotation you need to make a POST call to the following url: POST/v1/Quotation/Create

FieldTypeLimitRequiredDescription
request_type_codestring50YesQuotation request type: TRAVEL_INSURANCE
insurance_type_codestring50YesInsurance type: TRAVEL_OUTBOUND (leaving Oman), TRAVEL_INBOUND (visiting Oman)
voucher_codestring50OptionalVoucher or promo code
policy_no_previousstring50OptionalPrevious policy number, if any
lang_codestring2OptionalRequest language: en, ar. Default: en
asyncboolean-Optionaltrue: create the quotation and return at once, read offers later. false: return the offers in the response. Recommended: false
include_databoolean-OptionalResponse includes additional data
include_resultboolean-OptionalResponse includes offers
client_type_idint-OptionalWebsite: 1, Mobile: 2, Kiosk: 3
collector_track_idstring50OptionalYour own unique reference for this request
reference_by_idInt64-OptionalBima customer id when the customer is logged in; otherwise 0
osstring50OptionalDevice operating system name, version
browserstring50OptionalDevice browser name, version
schedule
Trip dates object
FieldTypeLimitRequiredDescription
date_fromstring10YesDeparture date, dd/MM/yyyy; today or later
date_tostring10YesReturn date, dd/MM/yyyy; trip at most 365 days
customer
Customer (policy holder: the first traveller aged 16 or over, else the first traveller) object
FieldTypeLimitRequiredDescription
country_codestring5YesMobile dial code without +, e.g. 968
national_nostring15YesMobile number without the dial code. Oman: exactly 8 digits
contact_full_nostring20Yescountry_code + national_no, e.g. 96895542930
area_codestring3OptionalCalculated from contact_full_no when empty
subscriber_codestring15OptionalCalculated from contact_full_no when empty
id_nostring20OptionalSend ""; the first traveller's passport number is used
id_typeint-Fixed1
title_idint-Fixed1
first_namestring25OptionalSend ""; names are sent later
middle_namestring25OptionalSend ""
last_namestring25OptionalSend ""
emailstring50YesContact email
dobstring10YesPolicy holder's date of birth, dd/MM/yyyy
gender_idint-Fixed1
nationality_country_idint-YesFrom the nationalities lookup
region_id, city_id, town_idInt64-OptionalFrom the regions and cities lookup; otherwise 0
pobox_nostring10OptionalP.O. Box number
addressstring30Fixed"Muscat Oman"
address2string30OptionalAddress line 2
travel
Trip direction and countries object
FieldTypeLimitRequiredDescription
bound_idint-Yes2 outbound, 1 inbound (must match insurance_type_code)
traveling_from_country_idint-YesOutbound: Oman (171). Inbound: the country the visitors come from
destination_countriesarray1-10YesItems { "country_id": 226 } from the countries lookup. Inbound: Oman only
insurers
Travellers array, one row per traveller (1 to 10), in order array
FieldTypeLimitRequiredDescription
idInt64-Optional0 for a new traveller
dobstring10YesDate of birth, dd/MM/yyyy (1900 to today)
nationality_country_idInt64-YesFrom the nationalities lookup. Must not be one of the destination_countries
gender_idInt64-OptionalDefault: 1 (Male); the real gender is sent later with UpdateInsurers
relation_idInt64-OptionalDefault: Self; the real relation is sent later with UpdateInsurers
{ "request_type_code": "TRAVEL_INSURANCE", "insurance_type_code": "TRAVEL_OUTBOUND", "lang_code": "en", "voucher_code": "", "reference_by_id": 0, "async": false, "customer": { "id_no": "", "id_type": 1, "id_expire_date": "", "license_no": "", "country_code": "968", "area_code": "", "subscriber_code": "", "national_no": "95542930", "contact_full_no": "96895542930", "title_id": 1, "first_name": "", "middle_name": "", "last_name": "", "email": "name@example.com", "nationality_country_id": 171, "nationality_country_code": "OM", "nationality_country_name": "Omani", "residence_country_id": 0, "dob": "04/03/1985", "passport_no": "", "gender_id": 1, "gender_name": "", "region_id": 0, "region_name": "", "city_id": 0, "city_name": "", "town_id": 0, "pobox_no": "", "address": "Muscat Oman", "address2": "" }, "client_type_id": 1, "os": "Windows", "browser": "Chrome", "schedule": { "date_from": "10/09/2026", "date_to": "17/09/2026" }, "travel": { "bound_id": 2, "traveling_from_country_id": 171, "destination_countries": [ { "country_id": 226 }, { "country_id": 190 } ] }, "insurers": [ { "id": 0, "dob": "04/03/1985", "nationality_country_id": 171, "gender_id": 1 }, { "id": 0, "dob": "12/06/2015", "nationality_country_id": 171, "gender_id": 1 } ] }
Response The response has the same envelope and data as Quotation/Read. Travel offers are usually group offers (offer_group_id) covering all travellers.
Travellers under 16 Travellers under 16 need at least one traveller aged 16 or over on the same quote. The destination ids in the example are illustrative; take real ids from the countries lookup.

Read Travellers

Returns the travellers saved on a quotation, with their ids. Use it to refill an edit form and before updating travellers. You need to make a POST call to the following url: POST/v1/Quotation/ReadInsurers

Field Type Limit Required Description
quotation_idstring500YesQuotation Id (encrypted)
lang_codestring2YesRequest language: en, ar
{ "quotation_id": "di84QXpYWDRp...", "lang_code": "en" }

data is an array, one item per traveller:

Field Type Description
idintTraveller id; send it back when editing or updating
dobstringDate of birth, d/M/yyyy
full_name, first_name, middle_name, last_namestringTraveller's names (empty until updated)
title_id, title_nameint, stringTitle
passport_nostringPassport number
gender_id, gender_nameint, stringGender
nationality_country_id, nationality_country_nameint, stringNationality
relation_id, relation_nameint, stringRelation to the policy holder

Update Travellers

After the customer picks an offer, every traveller's personal details are saved before Submit. To change dates of birth or the number of travellers (which changes the price), edit the quotation instead. You need to make a POST call to the following url: POST/v1/Quotation/UpdateInsurers

Field Type Limit Required Description
quotation_idstring500YesQuotation Id (encrypted)
lang_codestring2YesRequest language: en, ar
insurers
Travellers array, one item for every traveller on the quote array
Field Type Limit Required Description
idInt64-YesTraveller id from ReadInsurers. 0 adds a new traveller record without re-pricing
title_idint-YesFrom the titles lookup
first_namestring30YesLetters as in the passport
middle_namestring30OptionalLetters as in the passport
last_namestring30YesLetters as in the passport
dobstring10Yesdd/MM/yyyy, unchanged from the quote (changing it means re-creating the quote)
nationality_country_idint-YesFrom the nationalities lookup. Must not be one of the quote's destination countries
passport_nostring20YesLetters and digits, upper case
gender_idint-Yes1 Male, 2 Female (genders lookup)
relation_idint-YesFrom the relation titles lookup. The first traveller is usually Self
{ "quotation_id": "di84QXpYWDRp...", "lang_code": "en", "insurers": [ { "id": 17255, "title_id": 1, "first_name": "Saif", "middle_name": "", "last_name": "Almaluk", "dob": "04/03/1985", "nationality_country_id": 171, "passport_no": "A1234567", "gender_id": 1, "relation_id": 1 } ] }
Response status_code is "200" when all travellers were saved. Otherwise data[] lists each traveller with its own status_code ("Success" or the reason) and status_message; show those messages next to the right traveller.

Submit Data

Call UpdateInsurers first (all travellers), then lock the chosen offer. After it the quotation status is Submitted and Review returns the payment amounts. To submit a quotation you need to make a POST call to the following url: POST/v1/Quotation/Submit

FieldTypeLimitRequiredDescription
quotation_idstring500YesQuotation Id (encrypted)
offer_idstring20ConditionalSelected offer's id. Send exactly one of offer_id / offer_group_id
offer_group_idstring20ConditionalSelected group offer's id (offers covering several insured persons)
lang_codestring2YesRequest language: en, ar
policy_no_previousstring50OptionalPrevious policy number, if any
schedule
Policy start object
FieldTypeLimitRequiredDescription
date_fromstring10OptionalNot used: the trip dates from the quotation apply
customer
Customer (policy holder: the first traveller) object
FieldTypeLimitRequiredDescription
first_name, middle_name, last_namestring25OptionalTaken from the first traveller (ReadInsurers)
emailstring50YesPolicy documents are sent to it
contact_full_nostring20ConditionalThe quotation's contact number; required when documents are sent
documents
Files for the required documents, one item per document type. Empty array when none array
FieldTypeLimitRequiredDescription
doc_type_idInt64-YesDocument type from RequiredDocuments, e.g. 67
ref_id_subInt64-Optional0
file_namestring100YesFile name with extension, e.g. license-front.jpg
data_base64stringstring5 MBConditionalFile content in base64 without the data: prefix. Send this or file_url
file_urlstring500ConditionalFull http(s) URL of the file. Send this or data_base64string
question_answers
Answers to the offer's questions. Empty array when none array
FieldTypeLimitRequiredDescription
question_idInt64-YesQuestion unique id
option_idInt64-ConditionalSelected option id for choice questions; otherwise 0
answerstring50YesAnswer value
input_detilsstring500OptionalAdditional input details if required
{ "quotation_id": "di84QXpYWDRp...", "offer_group_id": "32566", "lang_code": "en", "customer": { "country_code": "968", "national_no": "95542930", "contact_full_no": "96895542930", "first_name": "Saif", "middle_name": "", "last_name": "Almaluk", "passport_no": "A1234567", "email": "name@example.com" } }
Response On success status_code is "200" and the quotation status becomes Submitted. Otherwise show status_message and messages[] and let the customer correct the form.