OTHER APIs

    API Endpoint

        https://test.bima.om/
                

RECENT REQUESTS

                    Response:


   
{
    "statusCode": "OK",
    "statusMessage": null,
    "Data": [
        {
            "EntityCode": "Insurance",
            "ProviderID": 10016,
            "RequestID": 4463702,
            "ReferenceNo": "F896B91B-B5D9-4E61-93B4-75B70A0EC8E5",
            "ServiceCode": "THIRD_PARTY",
            "ServiceName": "Third Party",
            "ProviderName": "Oman Qatar Insurance",
            "PolicyStatus": "Pending",
            "PolicyDateFrom": "2024-12-07T00:00:00",
            "PolicyDateTo": "2025-12-06T00:00:00",
            "AttributeText1": "R Y",
            "AttributeText2": "2731",
            "AttributeText3": "4 WHEEL DRIVE",
            "AttributeText4": "TUCSON",
            "AttributeText5": "HYUNDAI",
            "IconUrl": "https://bima.om//img/icons/m/THIRD_PARTY.png",
            "ImageURLThumbnail": "https://bima.om///img/Vehicles/10/201004/2016/cd777c3c-1e68-409b-a3e2-b8037ba4e0d6.jpg?v=1,https://bima.om///img/Vehicles/10/201004/2016/0d7d9616-fbd0-4da8-82a7-491d72faa30e.jpg?v=1",
            "RenewalStatusCode": null,
            "JobStatusCode": "",
            "step_code": "working_on_it",
            "step_title": "Working on it ",
            "step_sub_title": "Shortly our customer representative will get in touch with you.",
            "step_ImageURLThumbnail": "https://bima.om//img/icons/m/active/waiting_documents.gif?v=1"
        },
        {
            "EntityCode": "Insurance",
            "ProviderID": 10023,
            "RequestID": 4463701,
            "ReferenceNo": "CC266B33-F6B9-47E3-AE71-4957E112A04F",
            "ServiceCode": "THIRD_PARTY",
            "ServiceName": "Third Party",
            "ProviderName": "Muscat Insurance",
            "PolicyStatus": "Pending",
            "PolicyDateFrom": "2024-12-07T00:00:00",
            "PolicyDateTo": "2025-12-06T00:00:00",
            "AttributeText1": "R Y",
            "AttributeText2": "2731",
            "AttributeText3": "4 WHEEL DRIVE",
            "AttributeText4": "TUCSON",
            "AttributeText5": "HYUNDAI",
            "IconUrl": "https://bima.om//img/icons/m/THIRD_PARTY.png",
            "ImageURLThumbnail": "https://bima.om///img/Vehicles/10/201004/2016/cd777c3c-1e68-409b-a3e2-b8037ba4e0d6.jpg?v=1,https://bima.om///img/Vehicles/10/201004/2016/0d7d9616-fbd0-4da8-82a7-491d72faa30e.jpg?v=1",
            "RenewalStatusCode": null,
            "JobStatusCode": "",
            "step_code": "working_on_it",
            "step_title": "Working on it ",
            "step_sub_title": "Shortly our customer representative will get in touch with you.",
            "step_ImageURLThumbnail": "https://bima.om//img/icons/m/active/waiting_documents.gif?v=1"
        } 
    ]
}

Use this API to get customer recent requests, specify customer contact number including country code and language code
GET: /api/Insurance/GetCustomerRecentRequests?contactNo=96895542930&langCode=en

REQUEST DETAILS

                    Response:


   
{
    "thumbnail": [
        "https://bima.om/\\img\\Vehicles\\10\\201004\\2016\\cd777c3c-1e68-409b-a3e2-b8037ba4e0d6.jpg",
        "https://bima.om/\\img\\Vehicles\\10\\201004\\2016\\0d7d9616-fbd0-4da8-82a7-491d72faa30e.jpg"
    ],
    "policy_from": null,
    "policy_to": null,
    "issue_date": null,
    "entity_code": "Insurance",
    "prvider_name": "Oman Qatar Insurance",
    "policy_no": "",
    "contact_no_road_side_assistance": "80009111",
    "road_side_assistance_html": "
html content
",
    "policy_status": "Pending",
    "data": [
        {
            "title": "Owner Name",
            "value": "Mohammad Ali Al Badi"
        },
        {
            "title": "License ID",
            "value": "99086408"
        },
        {
            "title": "Vehicle",
            "value": "R Y / 2731"
        },
        {
            "title": "Model",
            "value": "HYUNDAI / TUCSON"
        },
        {
            "title": "Insurance Type",
            "value": "Third Party"
        },
        {
            "title": "Provider name",
            "value": "Oman Qatar Insurance"
        },
        {
            "title": "Date From",
            "value": "07/12/2024"
        },
        {
            "title": "Date To",
            "value": "06/12/2025"
        }
    ],
    "additional_drivers": [
        {
            "id": "1984792",
            "first_name": "",
            "last_name": "Jabbar",
            "age": "50"
        },
        {
            "id": "1984793",
            "first_name": "Nadir Sali",
            "last_name": "Al Naimi",
            "age": "20"
        }
    ],
    "travelers": null,
    "covers": [
        {
            "Title": "Driver & Family",
            "Subtitle": "Personal Accident Benefit Cover",
            "Code": "PAB"
        },
        {
            "Title": "Bima Car Replacement",
            "Subtitle": "3 days",
            "Code": "CAR_REPLACEMENT"
        }
    ],
    "follow_up": [
        {
            "message": "Payment processed successfully\r\n",
            "date_time": "07/04/2024 13:42"
        }
    ],
    "documents_required": [
        {
            "order_no": 18.000,
            "doc_type_code": "LicenseFront",
            "doc_type": "License front side",
            "icon_url": ""
        },
        {
            "order_no": 19.000,
            "doc_type_code": "LicenseBack",
            "doc_type": "License back side",
            "icon_url": ""
        },
        {
            "order_no": 20.000,
            "doc_type_code": "MulkiyaBack",
            "doc_type": "Mulkia back side",
            "icon_url": ""
        },
        {
            "order_no": 21.000,
            "doc_type_code": "MulkiyaFront",
            "doc_type": "Mulkia front side",
            "icon_url": ""
        }
    ],
    "status_code": "OK",
    "status_message": null,
    "step_code": "working_on_it",
    "step_title": "Working on it ",
    "step_sub_title": "Shortly our customer representative will get in touch with you.",
    "step_ImageURLThumbnail": "https://bima.om/img/icons/m/active/waiting_documents.gif?v=1",
    "attribute_text1": "R Y",
    "attribute_text2": "2731",
    "attribute_text3": "4 WHEEL DRIVE",
    "attribute_text4": "TUCSON",
    "attribute_text5": "HYUNDAI",
    "attribute_no1": 0,
    "attribute_no2": 0
}

To get details of paid requests, use below API.
GET: /api/Insurance/GetPolicyDetails?id=4463702&langcode=en

The response is including, request status, request details (dictionary data), additional drivers, travelers, covers, follow-up comments, documents required and images for request if available.

REQUEST PARAMETERS

Field	Type	Limit	Required	Description
ID	long		Yes	Unique request id received in API response (GetCustomerRecentRequests)
contactNo	String	min 11, max 15 chars	Yes	The Customer Contact Number including Country Code
langCode	String	2 Chars	Yes	language code

POLICY DOCUMENTS

    Response :

   {
    "data": [
        {
            "EntityCode": "Insurance",
            "SharedCode": "7DFC82FD-0A5D-42EB-964B-B5EBA4A80BF6",
            "RefID": "CC266B33-F6B9-47E3-AE71-4957E112A04F",
            "FileName": "stamp-ico.jpeg",
            "FileContentType": "image/jpeg",
            "ThumbnailURL": "/Uploads/thumb/2024\\ef97192e-9724-4a47-a431-831e080c1f7a.jpg",
            "FileExtension": ".jpeg",
            "FileSize": 7260,
            "FileSizeDisplay": "7.1KB",
            "DocType": "Policy Document"
        },
        {
            "EntityCode": "Insurance",
            "SharedCode": "70DBBF2A-ABEC-470D-9CF2-3AFAB2074AE1",
            "RefID": "CC266B33-F6B9-47E3-AE71-4957E112A04F",
            "FileName": "Car Replacement By Bima.pdf",
            "FileContentType": "application/pdf",
            "ThumbnailURL": "/img/icons/Ext/pdf.png",
            "FileExtension": ".pdf",
            "FileSize": 384288,
            "FileSizeDisplay": "375.3KB",
            "DocType": "Car Replacement"
        }
    ],
    "statusCode": "OK",
    "statusMessage": null
}

You can get list of policy documents for completed requests. Use below API to read available documents GET: /api/Document/GetSharedDocuments/?entityCode=Insurance&refID=CC266B33-F6B9-47E3-AE71-4957E112A04F

REQUEST PARAMETERS

Field	Type	Limit	Required	Description
quotation_id	String		Yes	Quotation unique reference
entityCode	String		Yes	Available in API response (GetCustomerRecentRequests)

DOWNLOAD DOCUMENT

To download a policy document, use below API.
/Document/SharedDownload?id=7DFC82FD-0A5D-42EB-964B-B5EBA4A80BF6&refID=CC266B33-F6B9-47E3-AE71-4957E112A04F

REQUEST PARAMETERS

Field	Type	Description
id	String		Yes	The SharedCode is available in API response
refID	String		Yes	Quotation unique reference