List policies

List policies

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

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

fetch('https://sandbox.yasmina.ai/api/v2/car/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/v2/car/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/v2/car/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/v2/car/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": 123,
      "meta_data": {
        "extra_fields": {},
        "incorrect_info_message": "<string>"
      },
      "status": 0,
      "client_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "product_id": 123,
      "insurance_company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "provider_policy_id": "<string>",
      "provider_policy": "<string>",
      "policy_url": "<string>",
      "invoice": "<string>",
      "invoice_url": "<string>",
      "payment_link": "<string>",
      "price": 123,
      "redirect_url": "<string>",
      "start_date": "2023-12-25",
      "uploaded_at": "2023-11-07T05:31:56Z",
      "purchased_at": "2023-11-07T05:31:56Z",
      "transfer_date_at": "2023-11-07T05:31:56Z",
      "cancellation_request_at": "2023-11-07T05:31:56Z",
      "canceled_at": "2023-11-07T05:31:56Z",
      "cancellation_confirmed_at": "2023-11-07T05:31:56Z",
      "cancellation_document": "<string>",
      "is_old_policy": 123,
      "pdf_parsed": 123,
      "has_sent_cancellation_email": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "deleted_at": "2023-11-07T05:31:56Z"
    }
  ],
  "first_page_url": "<string>",
  "from": 123,
  "last_page": 123,
  "last_page_url": "<string>",
  "next_page_url": "<string>",
  "path": "<string>",
  "per_page": 123,
  "prev_page_url": "<string>",
  "to": 123,
  "total": 123
}

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

GET

car

policies

List policies

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

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

fetch('https://sandbox.yasmina.ai/api/v2/car/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/v2/car/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/v2/car/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/v2/car/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": 123,
      "meta_data": {
        "extra_fields": {},
        "incorrect_info_message": "<string>"
      },
      "status": 0,
      "client_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "product_id": 123,
      "insurance_company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "provider_policy_id": "<string>",
      "provider_policy": "<string>",
      "policy_url": "<string>",
      "invoice": "<string>",
      "invoice_url": "<string>",
      "payment_link": "<string>",
      "price": 123,
      "redirect_url": "<string>",
      "start_date": "2023-12-25",
      "uploaded_at": "2023-11-07T05:31:56Z",
      "purchased_at": "2023-11-07T05:31:56Z",
      "transfer_date_at": "2023-11-07T05:31:56Z",
      "cancellation_request_at": "2023-11-07T05:31:56Z",
      "canceled_at": "2023-11-07T05:31:56Z",
      "cancellation_confirmed_at": "2023-11-07T05:31:56Z",
      "cancellation_document": "<string>",
      "is_old_policy": 123,
      "pdf_parsed": 123,
      "has_sent_cancellation_email": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "deleted_at": "2023-11-07T05:31:56Z"
    }
  ],
  "first_page_url": "<string>",
  "from": 123,
  "last_page": 123,
  "last_page_url": "<string>",
  "next_page_url": "<string>",
  "path": "<string>",
  "per_page": 123,
  "prev_page_url": "<string>",
  "to": 123,
  "total": 123
}

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

Authorizations

Authorization

string

header

required

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

Query Parameters

vin

string

car_sequence_number

string

current_car_owner

string

per_page

integer

Response

Success. Returns a paginated list of policies.

Standard paginated response. data holds the policies for the current page.

current_page

integer

data

object[]

Hide child attributes

data.id

integer

Yasmina's unique identifier for the policy. Use it to correlate webhook payloads with your records.

data.meta_data

object

The information the policy was requested with: vin, email, car_sequence_number, current_car_owner, new_owner_id, the stored istimarah document path, and the extra_fields object you submitted (echoed back unchanged, useful for carrying your own reference IDs). When the policy is placed on hold (status = 3), incorrect_info_message explains what needs to be corrected.

Hide child attributes

data.meta_data.extra_fields

object

The free-form object submitted when the policy was requested, echoed back unchanged.

data.meta_data.incorrect_info_message

string

Present when the policy has been placed on hold (status = 3). Explains which submitted information needs to be corrected.

data.status

enum<integer>

Policy lifecycle status:

0 — Pending issuance: the request was received and the policy has not been issued yet.
1 — Issued: the policy has been issued; policy_url and invoice_url point to the policy and invoice documents.
2 — Canceled: cancellation was requested or completed (cancellation_request_at / canceled_at are set).
3 — On hold, correction required: Yasmina flagged the submitted information as incorrect (for example an unreadable istimarah). The reason is provided in meta_data.incorrect_info_message. This status is not final: once a corrected document is provided, the status returns to 0 (pending) and the policy can still be issued (1).

Every status change triggers the Status Update webhook, so your webhook endpoint should accept any transition between these values.

Available options:

0,

1,

2,

3

data.client_id

string<uuid>

Identifier of your client account.

data.product_id

integer

Identifier of the Yasmina product this policy belongs to.

data.insurance_company_id

string<uuid> | null

Identifier of the insurance company issuing the policy.

data.provider_policy_id

string | null

The policy number assigned by the policy provider. null until assigned.

data.provider_policy

string | null

Storage path of the issued policy document. Use policy_url for a downloadable link. null until the policy is issued.

data.policy_url

string | null

Download URL of the issued policy document. null until the policy is issued.

data.invoice

string | null

Storage path of the invoice document. Use invoice_url for a downloadable link. null until available.

data.invoice_url

string | null

Download URL of the invoice document. null until available.

data.payment_link

string | null

Secure payment link generated by Yasmina, when payment is required.

data.price

number | null

Price of the policy in Saudi Riyal.

data.redirect_url

string | null

URL the customer is redirected to after payment, when configured.

data.start_date

string<date> | null

Start date of the policy coverage.

data.uploaded_at

string<date-time> | null

When the issued policy document was uploaded.

data.purchased_at

string<date-time> | null

When the policy was purchased.

data.transfer_date_at

string<date-time> | null

When the vehicle ownership transfer took place.

data.cancellation_request_at

string<date-time> | null

When cancellation was requested. Non-null implies status = 2.

data.canceled_at

string<date-time> | null

When the policy was canceled. Non-null implies status = 2.

data.cancellation_confirmed_at

string<date-time> | null

When the cancellation was confirmed by the insurance company.

data.cancellation_document

string | null

Storage path of the cancellation document submitted with a cancellation request.

data.is_old_policy

integer

Internal flag; 0 for policies issued through this API.

data.pdf_parsed

integer

Internal flag indicating whether the issued policy PDF has been parsed.

data.has_sent_cancellation_email

integer

Internal flag indicating whether a cancellation email has been sent.

data.created_at

string<date-time>

When the policy request was created.

data.updated_at

string<date-time>

When the policy was last updated.

data.deleted_at

string<date-time> | null

When the policy was deleted, if ever.

first_page_url

string

from

integer | null

last_page

integer

last_page_url

string

next_page_url

string | null

path

string

per_page

integer

prev_page_url

string | null

integer | null

total

integer

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