Authentication
SME Medical APIs
Motor Insurance APIs (Multiple Providers)
Property Insurance APIs
Travel Insurance APIs
Life (S&P) Insurance APIs
TPL Motor Insurance - Flat Fee APIs V2
TPL Motor Insurance APIs - Flat Fee
Horse Insurance APIs
Payment
Issue policy
curl --request POST \
--url https://sandbox.yasmina.ai/api/v1/property/policies \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"insurance_provider": "walaa",
"personal_details": {
"email": "[email protected]",
"phone_number": "+966501234567",
"name": "Fahad Al-Qahtani",
"birthdate": "1990-05-14",
"nationality": "SA",
"nationality_id": "1023456789",
"gender": "M"
},
"building_details": {
"building_age": 8,
"building_type": "Apartment",
"apartment_size": 120
},
"address": {
"street_name": "King Abdulaziz Road",
"building_number": "345",
"district_name": "Al Olaya",
"city_name": "Riyadh",
"additional_number": "1234",
"zip_code": "12233",
"unit_number": "12B"
},
"start_date": "2025-12-11",
"has_agreed_to_terms_and_conditions": true
}
'{
"id": 655,
"meta_data": {
"insurance_provider": "walaa",
"has_agreed_to_terms_and_conditions": true,
"start_date": "2025-12-11",
"property_cost": 500000,
"documents": [
"gOSkcUZnQQpV3YLvUygSrmkTh6L9g3gxKvFbIfwU.docx"
],
"personal_details": {
"name": "Fahad Al-Qahtani",
"email": "[email protected]",
"birthdate": "1990-05-14",
"nationality": "SA",
"phone_number": "+966501234567",
"nationality_id": "1023456789"
},
"building_details": {
"building_age": 8,
"building_type": "Apartment",
"apartment_size": 120
},
"address": {
"street_name": "King Abdulaziz Road",
"building_number": "345",
"district_name": "Al Olaya",
"city_name": "Riyadh",
"additional_number": "1234",
"zip_code": "12233",
"unit_number": "12B"
}
},
"provider_policy_id": null,
"provider_policy": null,
"client_id": "9f7db0ed-0783-4654-9b18-47c316809204",
"created_at": "2025-07-28T09:54:03.000000Z",
"canceled_at": null,
"status": 0
}Issue policy
For issuing a new policy
POST
/
policies
Issue policy
curl --request POST \
--url https://sandbox.yasmina.ai/api/v1/property/policies \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"insurance_provider": "walaa",
"personal_details": {
"email": "[email protected]",
"phone_number": "+966501234567",
"name": "Fahad Al-Qahtani",
"birthdate": "1990-05-14",
"nationality": "SA",
"nationality_id": "1023456789",
"gender": "M"
},
"building_details": {
"building_age": 8,
"building_type": "Apartment",
"apartment_size": 120
},
"address": {
"street_name": "King Abdulaziz Road",
"building_number": "345",
"district_name": "Al Olaya",
"city_name": "Riyadh",
"additional_number": "1234",
"zip_code": "12233",
"unit_number": "12B"
},
"start_date": "2025-12-11",
"has_agreed_to_terms_and_conditions": true
}
'{
"id": 655,
"meta_data": {
"insurance_provider": "walaa",
"has_agreed_to_terms_and_conditions": true,
"start_date": "2025-12-11",
"property_cost": 500000,
"documents": [
"gOSkcUZnQQpV3YLvUygSrmkTh6L9g3gxKvFbIfwU.docx"
],
"personal_details": {
"name": "Fahad Al-Qahtani",
"email": "[email protected]",
"birthdate": "1990-05-14",
"nationality": "SA",
"phone_number": "+966501234567",
"nationality_id": "1023456789"
},
"building_details": {
"building_age": 8,
"building_type": "Apartment",
"apartment_size": 120
},
"address": {
"street_name": "King Abdulaziz Road",
"building_number": "345",
"district_name": "Al Olaya",
"city_name": "Riyadh",
"additional_number": "1234",
"zip_code": "12233",
"unit_number": "12B"
}
},
"provider_policy_id": null,
"provider_policy": null,
"client_id": "9f7db0ed-0783-4654-9b18-47c316809204",
"created_at": "2025-07-28T09:54:03.000000Z",
"canceled_at": null,
"status": 0
}Documentation Index
Fetch the complete documentation index at: https://docs.yasmina.ai/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Available options:
walaa Example:
"walaa"
Hide child attributes
Hide child attributes
Example:
Example:
"+966501234567"
Example:
"Fahad Al-Qahtani"
Example:
"1990-05-14"
Available options:
SA, AF, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BA, BW, BV, BR, BQ, IO, VG, BN, BG, BF, BI, KH, CM, CA, CT, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, HR, CU, CY, CZ, CI, DK, DJ, DM, DO, NQ, DD, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, FQ, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IT, JM, JP, JE, JT, JO, KZ, KE, KI, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, FX, MX, FM, MI, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, AN, NT, NC, NZ, NI, NE, NG, NU, NF, KP, VD, MP, NO, OM, PC, PK, PW, PS, PA, PZ, PG, PY, YD, PE, PH, PN, PL, PT, PR, QA, RO, RU, RW, RE, BL, SH, KN, LC, MF, PM, VC, WS, SM, SN, RS, CS, SC, SL, SG, SK, SI, SB, SO, ZA, GS, KR, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, ST, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UM, PU, VI, UG, UA, SU, AE, GB, US, ZZ, UY, UZ, VU, VA, VE, VN, WK, WF, EH, YE, ZM, ZW, AX Example:
"SA"
Example:
"1023456789"
Available options:
M, F Hide child attributes
Hide child attributes
Example:
"King Abdulaziz Road"
Example:
"345"
Example:
"Al Olaya"
Available options:
Abha, Abu Arish, Ad Dair, Ad Darb, Ad Dilam, Ad Diriyah, Ad Duwadimi, Adam, Afif, Ahad Al Masarihah, Ahad Rufaydah, Al Aflaj, Al Ahsa, Al Aqiq, Al Ardiyat, Al Aridah, Al Asyah, Al Aydabi, Al Bad, Al Badai, Al Bahah, Al Birk, Al Bukayriyah, Al Ghat, Al Ghazalah, Al Hait, Al Hajrah, Al Hariq, Al Harjah, Al Harth, Al Hinakiyah, Al Is, Al Jumum, Al Kamil, Al Khafji, Al Kharj, Al Khurmah, Al Lith, Al Mahd, Al Majardah, Al Majmaah, Al Mandaq, Al Midhnab, Al Mukhwah, Al Muwayh, Al Muzahimiyah, Al Nuayriyah, Al Qara, Al Qatif, Al Qunfudhah, Al Qurayyat, Al Quwayiyah, Al Udayd, Al Ula, Al Uwayqilah, Al Wajh, An Nabhaniyah, An Namas, Ar Rass, Ar Rayn, Ar Rayth, Arar, As Sulaymi, As Sulayyil, Ash Shamli, Ash Shimasiyah, Ash Shinan, At Tuwal, Az Zulfi, Badr, Badr Al Janub, Bahrah, Baljurashi, Balqarn, Bani Hasan, Baqa, Bariq, Baysh, Bishah, Buqayq, Buraydah, Damad, Dammam, Dariyah, Dawamat Al Jandal, Duba, Duruma, Farasan, Farat Ghamid Az Zinad, Fayfa, Hafar Al Batin, Hail, Haqil, Harub, Hawtat Bani Tamim, Hubuna, Huraymila, Jazan, Jeddah, Jubail, Khamis Mushayt, Khaybar, Khobar, Khubash, Khulays, Makkah, Marat, Mawqaq, Maysan, Medina, Muhayil, Najran, Qaryah Al Ulya, Qilwah, Rabigh, Rafha, Ranyah, Ras Tannurah, Rijal Al Ma, Riyadh, Riyadh Al Khabra, Rumah, Sabya, Sakaka, Samtah, Sarat Abidah, Shaqra, Sharurah, Simira, Tabuk, Taif, Tanumah, Tarib, Tathlith, Tayma, Thadiq, Thar, Tubarjal, Turayf, Turubah, Umluj, Unayzah, Uqlat As Suqur, Uyun Al Jiwa, Wadi Ad Dawasir, Wadi Al Fara, Yadamah, Yanbu, Zahran Al Janub Example:
"Riyadh"
Example:
"1234"
Example:
"12233"
Example:
"12B"
Desired policy start date in YYYY-MM-DD format. Must be tomorrow or later.
Example:
"2025-12-11"
Example:
true
Example:
500000
Example:
100000
Response
Created
Example:
655
Hide child attributes
Hide child attributes
Example:
"walaa"
Example:
true
Example:
"2025-12-11"
Example:
500000
Hide child attributes
Hide child attributes
Example:
"Fahad Al-Qahtani"
Example:
Example:
"1990-05-14"
Example:
"SA"
Example:
"+966501234567"
Example:
"1023456789"
Hide child attributes
Hide child attributes
Example:
"King Abdulaziz Road"
Example:
"345"
Example:
"Al Olaya"
Example:
"Riyadh"
Example:
"1234"
Example:
"12233"
Example:
"12B"
Example:
null
Example:
null
Example:
"9f7db0ed-0783-4654-9b18-47c316809204"
Example:
"2025-07-28T09:54:03.000000Z"
Example:
null
Example:
0
⌘I