List policies

List policies

curl --request GET \
  --url https://sandbox.yasmina.ai/api/v1/car-comp/policies \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://sandbox.yasmina.ai/api/v1/car-comp/policies', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox.yasmina.ai/api/v1/car-comp/policies",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox.yasmina.ai/api/v1/car-comp/policies"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://sandbox.yasmina.ai/api/v1/car-comp/policies")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "current_page": 123,
  "data": [
    {
      "id": 1234,
      "status": 1,
      "price": 6770.51,
      "product_id": 6,
      "provider_policy_id": "P/219/5515/26/3854847/00",
      "provider_policy": "shahin-policies/00000000-0000-0000-0000-000000000000.pdf",
      "policy_url": "https://<object-storage-host>/<bucket>/shahin-policies/00000000-0000-0000-0000-000000000000.pdf",
      "invoice_url": "https://<object-storage-host>/<bucket>/shahin-policies/00000000-0000-0000-0000-000000000000_invoice.pdf",
      "payment_link": "https://portal.yasmina.ai/short/XXXXX",
      "redirect_url": "https://your-site.example/insurance-complete?order_id=12345",
      "start_date": "2026-10-02",
      "expiration_date": "2027-10-01",
      "created_at": "2026-10-01T08:24:11.000000Z",
      "purchased_at": "2026-10-01T08:26:58.000000Z",
      "uploaded_at": "2026-10-01T08:27:12.000000Z",
      "meta_data": {
        "insurance_type": "Comprehensive",
        "insurance_company": "Malath",
        "quote_request_id": 999,
        "quote_reference_id": "00000000-0000-0000-0000-000000000000",
        "quote_price_id": "00000000-0000-0000-0000-000000000000",
        "quote_expiry_date": "2026-10-02T03:14:23+03:00",
        "policy_start_date": "2026-10-02",
        "new_owner_id": "1xxxxxxxxx",
        "previous_owner_id": "7xxxxxxxxx",
        "car_sequence_number": 123456789,
        "custom_number": null,
        "iban": "SAxxxxxxxxxxxxxxxxxxxxxx",
        "benefits": []
      }
    }
  ],
  "first_page_url": "<string>",
  "from": 123,
  "last_page": 123,
  "last_page_url": "<string>",
  "links": [
    {
      "url": "<string>",
      "label": "<string>",
      "active": true
    }
  ],
  "next_page_url": "<string>",
  "path": "<string>",
  "per_page": 123,
  "prev_page_url": "<string>",
  "to": 123,
  "total": 123,
  "aggregates": {
    "total_count": 12,
    "total_price": 42850.75,
    "by_month": {
      "2026-06": {
        "count": 12,
        "total_price": 42850.75
      }
    }
  }
}

{
  "code": "40101",
  "message": "Unauthenticated"
}

GET

policies

List policies

curl --request GET \
  --url https://sandbox.yasmina.ai/api/v1/car-comp/policies \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://sandbox.yasmina.ai/api/v1/car-comp/policies', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox.yasmina.ai/api/v1/car-comp/policies",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox.yasmina.ai/api/v1/car-comp/policies"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://sandbox.yasmina.ai/api/v1/car-comp/policies")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "current_page": 123,
  "data": [
    {
      "id": 1234,
      "status": 1,
      "price": 6770.51,
      "product_id": 6,
      "provider_policy_id": "P/219/5515/26/3854847/00",
      "provider_policy": "shahin-policies/00000000-0000-0000-0000-000000000000.pdf",
      "policy_url": "https://<object-storage-host>/<bucket>/shahin-policies/00000000-0000-0000-0000-000000000000.pdf",
      "invoice_url": "https://<object-storage-host>/<bucket>/shahin-policies/00000000-0000-0000-0000-000000000000_invoice.pdf",
      "payment_link": "https://portal.yasmina.ai/short/XXXXX",
      "redirect_url": "https://your-site.example/insurance-complete?order_id=12345",
      "start_date": "2026-10-02",
      "expiration_date": "2027-10-01",
      "created_at": "2026-10-01T08:24:11.000000Z",
      "purchased_at": "2026-10-01T08:26:58.000000Z",
      "uploaded_at": "2026-10-01T08:27:12.000000Z",
      "meta_data": {
        "insurance_type": "Comprehensive",
        "insurance_company": "Malath",
        "quote_request_id": 999,
        "quote_reference_id": "00000000-0000-0000-0000-000000000000",
        "quote_price_id": "00000000-0000-0000-0000-000000000000",
        "quote_expiry_date": "2026-10-02T03:14:23+03:00",
        "policy_start_date": "2026-10-02",
        "new_owner_id": "1xxxxxxxxx",
        "previous_owner_id": "7xxxxxxxxx",
        "car_sequence_number": 123456789,
        "custom_number": null,
        "iban": "SAxxxxxxxxxxxxxxxxxxxxxx",
        "benefits": []
      }
    }
  ],
  "first_page_url": "<string>",
  "from": 123,
  "last_page": 123,
  "last_page_url": "<string>",
  "links": [
    {
      "url": "<string>",
      "label": "<string>",
      "active": true
    }
  ],
  "next_page_url": "<string>",
  "path": "<string>",
  "per_page": 123,
  "prev_page_url": "<string>",
  "to": 123,
  "total": 123,
  "aggregates": {
    "total_count": 12,
    "total_price": 42850.75,
    "by_month": {
      "2026-06": {
        "count": 12,
        "total_price": 42850.75
      }
    }
  }
}

{
  "code": "40101",
  "message": "Unauthenticated"
}

Authorizations

Authorization

string

header

required

JWT Authorization header using the Bearer scheme

Query Parameters

quote_request_id

integer

quote_price_id

string<uuid>

provider_policy_id

integer

car_sequence_number

string

new_owner_id

string

previous_owner_id

string

status

integer

min_price

number

max_price

number

per_page

integer

Required range: x >= 1

date_from

string<date>

Inclusive lower bound for the policy date. For issued policies (status=1), this filters by uploaded_at (the provider policy issue timestamp) and falls back to created_at when uploaded_at is unavailable. For other statuses, this filters by created_at.

Example:

"2026-06-01"

date_to

string<date>

Inclusive upper bound for the policy date. For issued policies (status=1), this filters by uploaded_at (the provider policy issue timestamp) and falls back to created_at when uploaded_at is unavailable. For other statuses, this filters by created_at.

Example:

"2026-06-30"

include_aggregates

boolean

When true, includes policy totals, total price, and monthly buckets for the filtered result set.

Example:

true

Response

Success

current_page

integer

data

object[]

Hide child attributes

data.id

integer

The Yasmina policy id. Quote it in support requests.

Example:

1234

data.status

enum<integer>

0 awaiting payment, 1 issued, 2 cancelled. It becomes 1 once payment has cleared and the insurer has issued the policy.

Available options:

0,

1,

2

Example:

1

data.price

number

What the customer paid, in SAR, including VAT.

Example:

6770.51

data.product_id

integer

Always 6 for comprehensive motor.

Example:

6

data.provider_policy_id

string | null

The insurer's own policy number, set when the policy is issued. Treat it as free text: insurers use their own formats, and many are not numeric.

Example:

"P/219/5515/26/3854847/00"

data.provider_policy

string | null

Storage key of the policy document. Use policy_url to download it.

Example:

"shahin-policies/00000000-0000-0000-0000-000000000000.pdf"

data.policy_url

string | null

Link to the policy document. Download the file rather than storing the link, and do not hardcode the host.

Example:

"https://<object-storage-host>/<bucket>/shahin-policies/00000000-0000-0000-0000-000000000000.pdf"

data.invoice_url

string | null

Link to the invoice, on the same terms as policy_url.

Example:

"https://<object-storage-host>/<bucket>/shahin-policies/00000000-0000-0000-0000-000000000000_invoice.pdf"

data.payment_link

string | null

Where the customer pays. Already used by the time the policy is issued.

Example:

"https://portal.yasmina.ai/short/XXXXX"

data.redirect_url

string | null

Where the customer is sent after paying, if you supplied one.

Example:

"https://your-site.example/insurance-complete?order_id=12345"

data.start_date

string<date>

First day of cover.

Example:

"2026-10-02"

data.expiration_date

string<date>

Last day of cover.

Example:

"2027-10-01"

data.created_at

string<date-time>

When the policy was created, before payment.

Example:

"2026-10-01T08:24:11.000000Z"

data.purchased_at

string<date-time> | null

When payment cleared. Null until the customer has paid.

Example:

"2026-10-01T08:26:58.000000Z"

data.uploaded_at

string<date-time> | null

When the policy document was attached. For issued policies this is the closest available issue timestamp.

Example:

"2026-10-01T08:27:12.000000Z"

data.meta_data

object

The details the policy was issued on.

Hide child attributes

data.meta_data.insurance_type

string

Comprehensive or TPL.

Example:

"Comprehensive"

data.meta_data.insurance_company

string

The insurer behind the policy.

Example:

"Malath"

data.meta_data.quote_request_id

integer

The quote request this policy came from. Use it to tie the policy back to your own record.

Example:

999

data.meta_data.quote_reference_id

string

The quote the customer chose.

Example:

"00000000-0000-0000-0000-000000000000"

data.meta_data.quote_price_id

string

The priced option the customer chose.

Example:

"00000000-0000-0000-0000-000000000000"

data.meta_data.quote_expiry_date

string<date-time>

When that price stopped being valid.

Example:

"2026-10-02T03:14:23+03:00"

data.meta_data.policy_start_date

string<date>

First day of cover, as sent when the policy was issued.

Example:

"2026-10-02"

data.meta_data.new_owner_id

string

National or Iqama id of the person insured.

Example:

"1xxxxxxxxx"

data.meta_data.previous_owner_id

string | null

Set when the vehicle is being transferred.

Example:

"7xxxxxxxxx"

data.meta_data.car_sequence_number

integer | null

The vehicle, when identified by sequence number.

Example:

123456789

data.meta_data.custom_number

string | null

The vehicle, when identified by customs card number.

Example:

null

data.meta_data.iban

string

The customer's payout account. Refunds are transferred to it; it is never charged.

Example:

"SAxxxxxxxxxxxxxxxxxxxxxx"

data.meta_data.benefits

string[]

The optional add-ons the customer chose.

Example:

[]

first_page_url

string

from

integer | null

last_page

integer

last_page_url

string

links

object[]

Hide child attributes

links.url

string | null

links.label

string

links.active

boolean

next_page_url

string | null

path

string

per_page

integer

prev_page_url

string | null

integer | null

total

integer

aggregates

object

Returned only when include_aggregates is true.

Hide child attributes

aggregates.total_count

integer

Example:

12

aggregates.total_price

number<float>

Example:

42850.75

aggregates.by_month

object

Monthly policy counts and sales totals keyed by YYYY-MM. For issued policies (status=1), buckets use uploaded_at and fall back to created_at.

Hide child attributes

aggregates.by_month.{key}

object

Hide child attributes

aggregates.by_month.{key}.count

integer

Example:

12

aggregates.by_month.{key}.total_price

number<float>

Example:

42850.75

Example:

{
  "2026-06": { "count": 12, "total_price": 42850.75 }
}

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

Horse Insurance APIs

Payment

Authorizations

Query Parameters

Response