Skip to main content
POST
Request quotes

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme

Headers

Accept-Language
enum<string>

Set to ar to receive Arabic-localized quote content.

Available options:
ar
Example:

"ar"

Body

application/json
otp
string
required

The OTP received by the customer from the Request OTP API

Pattern: ^\d{4}$
Example:

"1234"

owner_id
string
required

The owner's national ID (starts with 1 for Saudi nationals) or Iqama ID (starts with 2 for residents). Must be exactly 10 digits.

Pattern: ^(1|2)\d{9}$
email
string<email>
required

Email address must be valid and belongs to the customer

phone
string
required

Phone number must start with 05 and be 10 digits

Pattern: ^05\d{8}$
birthdate
string<date>
required

Birthdate in YYYY-MM-DD format

car_sequence_number
string
required

Car sequence number must be 8 or 9 digits

Pattern: ^\d{8,9}$
car_estimated_cost
number
required

Estimated cost of the car

custom_number
string

Customs card number between 100000 and 9999999999 for an imported vehicle. When provided, maker_code, model_code, and body_type_code are required, and car_sequence_number must be omitted.

Pattern: ^[1-9]\d{5,9}$
maker_code
integer

Required with custom_number. Use a code returned by GET /vehicle-makers.

Example:

101

model_code
integer

Required with custom_number. Use a code returned by GET /vehicle-models for the selected maker_code.

Example:

1001

body_type_code
integer

Required with custom_number. Use a code returned by GET /vehicle-body-types.

Example:

3

is_ownership_transfer
boolean
default:false

Indicates if the ownership is being transferred

current_car_owner_id
string

Required if is_ownership_transfer is true; the current owner's national ID (starts with 1) or Iqama ID (starts with 2). Must be exactly 10 digits.

Pattern: ^(1|2)\d{9}$
car_model_year
integer

Car model year between 1950 and next year

Required range: 1950 <= x <= 2026
start_date
string<date>

Desired policy start date in YYYY-MM-DD. Must be between tomorrow and 28 days from today (inclusive). The platform validates this range server-side.

Example:

"2025-12-11"

drivers
object[]

List of drivers for the vehicle. When provided, the sum of all driving_percentage values must equal 100, and the owner must be included among the drivers.

Example:

Response

The stored quote request, with one entry in quotes per provider offer.

The quote request as stored by Yasmina. It echoes the values you sent — so a stored response is enough to re-render the customer's page later — and adds the top-level id and the quotes array of provider offers. Policy issuance points back at one exact selection inside this response: the top-level id, one quotes[].quote_reference_id, one quotes[].prices[].quote_price_id from that same quote, and the quote_benefit_id of each paid benefit the customer chose.

id
integer

Yasmina's identifier for this quote request. Send it as quote_request_id when issuing a policy, and use it with the Show Quote and Delete Quote APIs.

quotes
object[]

One entry per offer returned by the insurance providers. Empty when no provider priced this vehicle and driver combination.

client_id
string<uuid>

Your client identifier. The same value on every quote request you create.

attachments
object | null

The five vehicle photos once uploaded, keyed by position. null until the Upload Vehicle Photos API is called.

created_at
string<date-time>

When the quote request was made. Read it together with quotes[].quote_expiry_date when deciding whether to re-quote.

updated_at
string<date-time>

When the record last changed, for example after vehicle photos were uploaded.

owner_id
string

The owner's national ID (starts with 1) or Iqama ID (starts with 2), echoed from the request.

Example:

"2234567890"

phone
string

The owner's phone number

birthdate
string<date>

The owner's birthdate. Hijri for Saudi nationals, Gregorian for others

car_sequence_number
integer

The car sequence number from 9 digits

custom_number
string

Customs card number for an imported vehicle. Present when custom_number was used in the request.

maker_code
integer

Vehicle maker code used to register a customs-card vehicle.

model_code
integer

Vehicle model code used to register a customs-card vehicle.

body_type_code
integer

Vehicle body-type code used to register a customs-card vehicle.

is_ownership_transfer
boolean

Whether it was a car transfer or not

car_estimated_cost
number

The estimated cost of the car

car_model_year
integer

The car model year

start_date
string<date>

Requested policy start date in YYYY-MM-DD. Returned if provided in the quote request.

drivers
object[]

List of drivers associated with this quote request. Returned if drivers were provided in the request.

email
string<email>

The owner's email, echoed from the request.

current_car_owner_id
string

The current owner's ID on an ownership transfer. Filled with owner_id when is_ownership_transfer is false.