Show policy

Show policy

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

import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://sandbox.yasmina.ai/api/v1/car-comp/policies/{carPolicy}', 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/{carPolicy}",
  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/{carPolicy}"

	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/{carPolicy}")

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

{
  "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": []
  }
}

GET

policies

{carPolicy}

Show policy

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

import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://sandbox.yasmina.ai/api/v1/car-comp/policies/{carPolicy}', 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/{carPolicy}",
  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/{carPolicy}"

	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/{carPolicy}")

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

{
  "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": []
  }
}

Authorizations

Authorization

string

header

required

JWT Authorization header using the Bearer scheme

Path Parameters

carPolicy

integer

required

Response

200 - application/json

Success

A motor policy. The same object is returned by Issue policy and Show policy, and is what the webhooks carry.

integer

The Yasmina policy id. Quote it in support requests.

Example:

1234

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

price

number

What the customer paid, in SAR, including VAT.

Example:

6770.51

product_id

integer

Always 6 for comprehensive motor.

Example:

6

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"

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"

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"

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"

payment_link

string | null

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

Example:

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

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"

start_date

string<date>

First day of cover.

Example:

"2026-10-02"

expiration_date

string<date>

Last day of cover.

Example:

"2027-10-01"

created_at

string<date-time>

When the policy was created, before payment.

Example:

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

purchased_at

string<date-time> | null

When payment cleared. Null until the customer has paid.

Example:

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

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"

meta_data

object

The details the policy was issued on.

Hide child attributes

meta_data.insurance_type

string

Comprehensive or TPL.

Example:

"Comprehensive"

meta_data.insurance_company

string

The insurer behind the policy.

Example:

"Malath"

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

meta_data.quote_reference_id

string

The quote the customer chose.

Example:

"00000000-0000-0000-0000-000000000000"

meta_data.quote_price_id

string

The priced option the customer chose.

Example:

"00000000-0000-0000-0000-000000000000"

meta_data.quote_expiry_date

string<date-time>

When that price stopped being valid.

Example:

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

meta_data.policy_start_date

string<date>

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

Example:

"2026-10-02"

meta_data.new_owner_id

string

National or Iqama id of the person insured.

Example:

"1xxxxxxxxx"

meta_data.previous_owner_id

string | null

Set when the vehicle is being transferred.

Example:

"7xxxxxxxxx"

meta_data.car_sequence_number

integer | null

The vehicle, when identified by sequence number.

Example:

123456789

meta_data.custom_number

string | null

The vehicle, when identified by customs card number.

Example:

null

meta_data.iban

string

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

Example:

"SAxxxxxxxxxxxxxxxxxxxxxx"

meta_data.benefits

string[]

The optional add-ons the customer chose.

Example:

[]

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

Path Parameters

Response