Upload documents

POST

policies

{propertyPolicy}

documents

Upload documents

curl --request POST \
  --url https://staging.yasmina.ai/api/v1/property/policies/{propertyPolicy}/documents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form document=@example-file

{
  "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.

Path Parameters

propertyPolicy

integer

required

Body

multipart/form-data

document

file

Supporting document

Response

Successfully uploaded

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

Cancel policyCancel a policy

⌘I

Upload documents

curl --request POST \
  --url https://staging.yasmina.ai/api/v1/property/policies/{propertyPolicy}/documents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form document=@example-file

{
  "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
}

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

Path Parameters

Body

Response