Issue policy

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"
  },
  "has_agreed_to_terms_and_conditions": true
}
'

{
  "id": 655,
  "meta_data": {
    "insurance_provider": "walaa",
    "has_agreed_to_terms_and_conditions": true,
    "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
}

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"
  },
  "has_agreed_to_terms_and_conditions": true
}
'

{
  "id": 655,
  "meta_data": {
    "insurance_provider": "walaa",
    "has_agreed_to_terms_and_conditions": true,
    "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
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

insurance_provider

enum<string>

required

Available options:

walaa

Example:

"walaa"

personal_details

object

required

Hide child attributes

personal_details.email

string<email>

required

Example:

"[email protected]"

personal_details.phone_number

string

required

Example:

"+966501234567"

personal_details.name

string

required

Example:

"Fahad Al-Qahtani"

personal_details.birthdate

string<date>

required

Example:

"1990-05-14"

personal_details.nationality

enum<string>

required

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"

personal_details.nationality_id

string

required

Example:

"1023456789"

personal_details.gender

enum<string>

Available options:

M,

F

building_details

object

required

Hide child attributes

building_details.building_age

integer

required

Example:

8

building_details.building_type

enum<string>

required

Available options:

villa,

apartment,

private_accommodation

Example:

"Apartment"

building_details.apartment_size

integer

required

Example:

120

address

object

required

Hide child attributes

address.street_name

string

required

Example:

"King Abdulaziz Road"

address.building_number

string

required

Example:

"345"

address.district_name

string

required

Example:

"Al Olaya"

address.city_name

enum<string>

required

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"

address.additional_number

string

required

Example:

"1234"

address.zip_code

string

required

Example:

"12233"

address.unit_number

string

required

Example:

"12B"

has_agreed_to_terms_and_conditions

boolean

required

Example:

true

property_cost

number

Example:

500000

contents_cost

number

Example:

100000

Response

Created

integer

Example:

655

meta_data

object

Hide child attributes

meta_data.insurance_provider

string

Example:

"walaa"

meta_data.has_agreed_to_terms_and_conditions

boolean

Example:

true

meta_data.property_cost

number

Example:

500000

meta_data.documents

string[]

meta_data.personal_details

object

Hide child attributes

meta_data.personal_details.name

string

Example:

"Fahad Al-Qahtani"

meta_data.personal_details.email

string<email>

Example:

"[email protected]"

meta_data.personal_details.birthdate

string<date>

Example:

"1990-05-14"

meta_data.personal_details.nationality

string

Example:

"SA"

meta_data.personal_details.phone_number

string

Example:

"+966501234567"

meta_data.personal_details.nationality_id

string

Example:

"1023456789"

meta_data.building_details

object

Hide child attributes

meta_data.building_details.building_age

integer

Example:

8

meta_data.building_details.building_type

string

Example:

"Apartment"

meta_data.building_details.apartment_size

integer

Example:

120

meta_data.address

object

Hide child attributes

meta_data.address.street_name

string

Example:

"King Abdulaziz Road"

meta_data.address.building_number

string

Example:

"345"

meta_data.address.district_name

string

Example:

"Al Olaya"

meta_data.address.city_name

string

Example:

"Riyadh"

meta_data.address.additional_number

string

Example:

"1234"

meta_data.address.zip_code

string

Example:

"12233"

meta_data.address.unit_number

string

Example:

"12B"

provider_policy_id

string | null

Example:

null

provider_policy

string | null

Example:

null

client_id

string<uuid>

Example:

"9f7db0ed-0783-4654-9b18-47c316809204"

created_at

string<date-time>

Example:

"2025-07-28T09:54:03.000000Z"

canceled_at

string<date-time> | null

Example:

null

status

integer

Example:

0

List policies

Cancellation status

⌘I

Authentication

SME Medical APIs

Motor Insurance APIs (Multiple Providers)

TPL Motor Insurance APIs

Property Insurance APIs

Travel Insurance APIs

Life (S&P) Insurance APIs

Horse Insurance APIs

Payment

Authorizations

Body

Response