​
Overview

The APIs in this documentation are designed to integrate smoothly with Yasmina’s platform, allowing efficient and secure handling of medical insurance-related data and actions. Whether you’re managing policies, processing claims, or accessing customer details, these APIs offer a reliable and developer-friendly interface. With well-defined endpoints and comprehensive support, integration is simple and enables clients to take full advantage of our services with minimal effort.

​
Steps

Below is the basic journey to requesting your first insurance(s)
1

Authorization

Get a an authorization token to use all our API’s. Click for more details.
Or go directly to Authorization API
2

Issue policies for your customers

Provide the property details such as VIN and Sequence number Click for more details.Or go directly to Issue policies API

​
Authorization

To access any of our API’s. You need to authorize yourself. We are using OAuth 2.0 client credentials to achieve that.
You will need client_id and client_secret. You can get these from your portal.

 After making the request, you will get access_token in the response. Example 
{
    "token_type": "Bearer",
    "expires_in": 31536000,
    "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiI5YmEyOTNmNy01ZjYyLTRlODItYmU5Yi1kODA0Y2M5ZDM5MmMiLCJqdGkiOiJlZWJjMWM5MWEyZThkMTVmNTYxNjZjMjkwM2Q0NTZjM2IzYWM5MTU5ZTdkODQ2YTE5NmFlYjcxMWM5OTJlMjc2MzAzNjY3MDA1MDQzM2U0OSIsImlhdCI6MTczNTkwNTE5OC40NTg5MiwibmJmIjoxNzM1OTA1MTk4LjQ1ODkyMSwiZXhwIjoxNzY3NDQxMTk4LjQ1Njk0LCJzdWIiOiIiLCJzY29wZXMiOltdfQ.Dy6df9fr4eBMLtkjnzcBjrXSg2AZLrmrBBC1NF8wmQaIOjcNffiqMiL9MqdMPj43Dxt4fj9rT1_S8dfwEpSbxNuIweNLOa7iDYpqMQ2l-cKG_sn24G27exZ9shLG8p2FHa4SHxSByRw00aCJceiTzq12LLNfc14rGPKZOv5Pi-HuLAP6ms_NfyN-KafOFOjYym4PyHCuTX8jEkoImgpBUpPgdnq1qyQdrZxL4grp0P_ezkhTgHgWwuzjSYgm4l-Eyga65kua-pdgWbhJ7-I1W_hjWT2dKCivcmk6nR9wtTjWs9hBvZrOfoZmox4YPIjZ_pvImZbHcZui-7xs80dnoaTKRviR8aot0cPIKoqRwinBodjWRh3QEu5juT1b7T-m85Wo_JNRoarKD4pW2Lzq7v1u9Z6PMEeYXvuFchzZ6HPvthblfwbtu3AX6ij0ZGlZPdMRdEiRtZf3dt8nsWdI-E_J0GAD-9wexlpNL92Z-IfuwMXuUQs_j4l92fcfBC_NxlEUTNACyOWPrA3V6ZSLHrga6W4Iz6Por3txzCsxlwvEBQAM70VyGeSqFi0wMLg2V8wVYAEpiEe2dl4RpMbUaPzRNc_KsDUYM_4DqwMTo2v2x4AAPxWmWiRn4PeAXovraN6Ll-eW9zq5hUbt3c-yj0spVYhJADHodoHmAdQM9MA"
}
Use the access_token and supply in the headers like this Authorization: Bearer <access_token> Go to the following link to use the Authorization API.
For security reasons. Do not make your client_id and client_secret public in your platform.

​
Get prices

Yasmina works with multiple insurance providers. You can retrieve and compare offers to help your client choose the most suitable option. Currently, we provide pricing from the following five providers:
  • Walaa
  • Medgulf
  • Tawuniya
  • Takaful Al-Rajhi
  • Wataniya
To get insurance prices, use the API below. You’ll need to provide either property_cost, contents_cost, or both: Get Prices

​
Issue policies

To issue policies, use the Issue Policies API. Choose from the providers listed in the prices section.

​
Upload policies

Supporting documents are required from your clients. These can include home photos, images of valuable contents, or surrounding areas. You can upload these documents using the Upload Document API.