Skip to main content

​
Overview

This guide walks you through integrating Yasmina’s Medical Insurance API into your platform. Using our secure and reliable endpoints, you’ll be able to request and manage policies, and issue claims. Everything you need to deliver insurance services seamlessly within your application.

​
Basic Journey

  1. Authorize: Get an access token to authenticate all API requests.
  2. Create a Company: Register the SME that will provide medical insurance for its employees.
  3. Choose a Package: Retrieve and review available medical insurance packages.
  4. Issue Insurance: Select the employees who will be covered and create their policies.
  5. Health Declarations: Complete forms on behalf of employees or send them directly for completion.
  6. Payment: Receive a secure payment link to finalize the purchase.

​
Authorization

To access any of our API’s. You need to authorize yourself using the Generate Token API. We are using the standard OAuth 2.0 client credentials.
 The Generate Token API requires 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"
}
The access_token must be used on all future Yasmina APIs and be supplied in the Authorization Header in the following form Authorization: Bearer {access_token}
For security reasons. Do not make your client_id and client_secret public in your platform.

​
Create a Company record

After acquiring an access_token, you can begin using the APIs. Before you produce policies for a company, you must create a company record. After creating the company record, you can request to issue policies to the employees of that company. The The Create Company API, will require few fields that define details of the company such as Email, Phone etc… It will return a response with a unique identifier (id). Here is an example of the response from the POST companies API. 
{
  "name": "Example company name",
  "name_ar": "مثال اسم شركة",
  "sponsor_number": "789",
  "email_address": "[email protected]",
  "phone_number": "+966512345678",
  "commercial_registration_number": "9876543210",
  "client_id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
  "updated_at": "2025-08-01T14:22:30.000000Z",
  "created_at": "2025-08-01T14:22:30.000000Z",
  "id": 42
}
You can also visit the List companies API to show all companies you’ve created

​
List available packages

After creating a company record, you can list available packages to the company. Check out the Categories API. This gives you a list of available insurance categories.
  1. The Insurance provider PDF
    • Contains an overview picture of what is provided by the Insurance provider
  2. The translations
    • The translations includes keys that map to the instructional text in Arabic and English that were provided by the insurance provider.
  3. The categories
    • The categories items uses these keys and gives the coverage values
Each employee can have a separate package. Coverage values can either be a number (the amount), or a boolean (whether it’s covered or not), or a text (the type of coverage) Each item in the categories has a category property. This is an important property as it is what you will need to provide when you issue policies. Notice the category field in the following sample of the categories response API. 
    "categories": {
        "basic": {
            "name": "Basic",
            "category": "basic",
            "maximum_annual_benefit_limit_per_person": 500000,
            "geography": "Saudi Arabia",
            "general_coverage": {
            ...
        }
        ...
    }

​
Issue insurance policies

To issue policies, you need to execute the Issue policies API. The API takes two fields. The company_id as referenced above. And an array called insured. The insured are the employees that the company wants to issue insurance for.policies Here is an example of a payload you would send 
{
  "insured": [
    {
        "name": "Abdullah Enizi",
        "nationality_iso": "SA",
        "category": "basic",
        "iqama_id": "123",
        "date_of_birth": "1988-04-20",
        "number_of_dependents": 1
    },
    {
        "name": "Samer Najjar",
        "nationality_iso": "JO",
        "category": "standard",
        "nationality_id": "123",
        "date_of_birth": "1988-04-20",
        "number_of_dependents": 1
    }
  ],
  "company_id": 1
}
Notice in the above, there are two employees within the company. One of them we are supplying the iqama_id as he is a Non-Saudi while the other we supply a nationality_id as he is Saudi.
The category that we are supplying is what was returned from the Categories API

​
HR declaration forms

The companies that have requested insurance needs to be supply the insurance provider with Medical forms. These are mandatory for insurance providers to know past medical histories. Yasmina offers two methods for submitting these forms:
  1. Fill Medical Forms: Company administrators fill out the forms on behalf of the employees.
  2. Dispatch Medical Forms: Company administrators dispatch the forms to employees, who then complete them individually.
Detailed explanations for each method are provided below.
The fill medical forms allows the company admin to do so on behalf of the employers of the company. It takes two fields of which both are objects all_employees and ids_or_emails.The idea behind the two fields, is to allow the Company admin to select the default answers for all employees, and then override the answers for specific employees.For example, let us say that all employees except 1 (for example employee with email [email protected]), never had surgeries before, we can declare the answer No on the surgery question in the all_employees field, but declare Yes for the other employee.employeeHere’s an example of such case
{
    "all_employees": {
        "allergies": "No",
        "current_medications": "No",
        "hospitalizations": "No",
        "pre_existing_conditions": "No",
        "past_surgeries": "No",
        "surgery_complications": "No",
        "chest_pain_or_breathlessness": "No",
        "heart_procedures": "No",
        "smoking": "No",
        "alcohol_consumption": "No",
        "physical_activity": "No",
        "family_history": "No",
        "chronic_conditions": ["None of the above"]
    },
    "ids_or_emails": [
        {
            "id_or_email": "[email protected]",
            "answers": {
                "allergies": "No",
                "current_medications": "No",
                "hospitalizations": "No",
                "pre_existing_conditions": "No",
                "past_surgeries": "Yes",
                "surgery_complications": "No",
                "chest_pain_or_breathlessness": "No",
                "heart_procedures": "No",
                "smoking": "No",
                "alcohol_consumption": "No",
                "physical_activity": "No",
                "family_history": "No",
                "chronic_conditions": ["Liver Disease"]
            }
        }
    ]
}
Check out the Fill medical forms API docs for all the supported props.
In this method, the Company admin puts a list of employees (emails, nationality ids, or Iqama ids). Yasmina then dispatches the medical form to each employee on email.The employees will get a link to fill the forms themselves.You can check the Dispatch Medical Form APIYou can put other components inside Accordions.

​
Payment

Yasmina will supply a payment link of which your clients can pay for the insurance. You must share this link in your platform.
⌘I