Bima Bima API Docs v1

Lookups

Master data lists that provide the ids used in quotation requests: countries, nationalities, titles, genders, relations and more.

Get Master Data

Ids sent in product requests (country, nationality, title, gender, relation) come from this API. Load the lists before creating a quotation. Set the flags you need to true; everything else false. You need to make a POST call to the following url: POST/v1/Data/GetMasterDataLOVs

Field Type Limit Required Description
lang_codestring2YesRequest language: en, ar
countryboolean-OptionalReturn countries
nationalityboolean-OptionalReturn nationalities
titlesboolean-OptionalReturn titles
gendersboolean-OptionalReturn genders
relation_titlesboolean-OptionalReturn relation_titles
regions, cities, region_and_citiesboolean-OptionalRegions and cities
occupation, occupation_qualifications, employments, banks, companiesboolean-OptionalPersonal and employment lists
property_types, property_ownership_types, property_cover_contents, unoccupancy_periodsboolean-OptionalProperty lists (Home & Contents)
makes, vehicle_insurance_typesboolean-OptionalVehicle lists
coverage_and_items, claim_limit_and_aggregator_limitboolean-OptionalCoverage lists
offer_id, category_type_code, occupation_codestring-OptionalFilters; send "" when not used
region_idint-OptionalFilter cities by region; 0 when not used
{ "lang_code": "en", "country": true, "nationality": true, "titles": true, "genders": true, "relation_titles": true, "regions": false, "occupation": false, "banks": false, "employments": false, "cities": false, "property_types": false, "property_ownership_types": false, "property_cover_contents": false, "makes": false, "companies": false, "vehicle_insurance_types": false, "unoccupancy_periods": false, "coverage_and_items": false, "region_and_cities": false, "occupation_qualifications": false, "claim_limit_and_aggregator_limit": false, "offer_id": "", "category_type_code": "", "region_id": 0, "occupation_code": "" }

Returned lists

List in data Item shape (example) Used for
countries { country_id: 3, country_code: "AF", country_name: "Afghanistan", nationality_name: "Afghan", calling_code: "93", order_no: 102 } Travel destinations / origin
nationalities Same shape as countries nationality_country_id of customers and travellers
titles { id: 6, code: "Dr", name: "Dr." } title_id (Mr, Mrs, Ms, Dr…; company titles are not used for people)
genders { id: 1, code: "Male", name: "Male" } gender_id (1 Male, 2 Female)
relation_titles { id: 7, code: "Daughter", name: "Daughter" } Travellers' relation to the policy holder
Oman country_id 171, country_code OM, calling code 968.

Motor plate codes

Motor quotes send the plate code as vehicle_code (the VehiclePlateCharCode, e.g. "S", "A B", "T B A"). Plate codes are at most 5 characters including single spaces; free text is Latin letters/digits. T B A is the code for a new, unregistered vehicle.