​
Overview

The API’s in this documentation has been designed to seamlessly integrate with Yasmina’s platform, enabling a smooth and efficient exchange of car insurance-related data and functionalities. Whether you’re looking to request or manage policies, handle claims, or access customer information, this API provides a robust and secure interface. With clear endpoints and comprehensive support, our goal is to simplify the integration process and ensure that our client can leverage the full potential of our insurance 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 car 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.

​
Issue policies

In order to Issue a policy. You can head to the Issue Policy API For issuing a policy, we need you to provide the following properties.
PropertyDescription
VINThe car VIN number. Made from a length of 17 alphanumerical characters. You cannot have 2 active policies from the same VIN. Make sure you cancel an existing policy for a particular VIN before issuing the other.
Car Sequence NumberThe sequence number of the car. Made out of 10 digits. You cannot have 2 active policies from the same VIN. Make sure you cancel an existing policy for a particular VIN before issuing the other.
Current car ownerThe national ID of the current owner (if this is a new car purchased by your business, then you need to provide the national ID of someone registered to the company).
New car ownerThe national ID of the new owner.
This is an example of the JSON payload that you might send. 
{
  "vin": "1HG2H4131e3211GRR",
  "car_sequence_number": "121236022",
  "current_car_owner": "1234567890",
  "new_owner_id": "1234567890"
}
To issue policies, you need to execute the Issue policies API).

​
Claims

You can issue a claim using our APIs. When you issue a claim, we communicate it with the Insurance provider, and giving them details of the incident. Go to the Issue Claim API in order to start the claim process for your customer.