Purchase

Purchase

curl --request POST \
  --url https://sandbox.yasmina.ai/api/v1/yasmina-schengen-travel/policies \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "quote_id": "Q-L5ELL0WU",
  "redirect_url": "<string>"
}
'

{
  "id": 936,
  "meta_data": {
    "bill": {
      "items": {},
      "adminFees": 25
    },
    "email": "[email protected]",
    "price": 92,
    "duration": 10,
    "quote_id": 1,
    "start_date": "2026-02-27",
    "travellers": [
      {
        "gender": "m",
        "relation": "self",
        "full_name": "Yasmina Alex",
        "nationality": "SA",
        "date_of_birth": "1982-04-20",
        "passport_number": "G12345678",
        "passport_expiry_date": "2026-10-30"
      }
    ],
    "multi_entry": false,
    "phone_number": "+966501234567",
    "date_of_birth": "1988-04-20",
    "nationality_id": "1234567890"
  },
  "product_id": 8,
  "client_id": "a0fd456b-853d-4511-b80f-2bfdb0e66303",
  "pdf_parsed": 0,
  "has_sent_cancellation_email": 0,
  "created_at": "2026-02-03T07:12:45.000000Z",
  "updated_at": "2026-02-03T07:12:45.000000Z",
  "status": 0,
  "is_old_policy": 0,
  "payment_link": "https://sandbox.yasmina.ai/short/4OrJN",
  "price": 92,
  "canceled_at": "2023-11-07T05:31:56Z",
  "provider_policy_id": "<string>",
  "provider_policy": {},
  "start_date": "2023-12-25",
  "cancellation_document": "<string>",
  "invoice": {},
  "transfer_date_at": "2023-11-07T05:31:56Z",
  "cancellation_request_at": "2023-11-07T05:31:56Z",
  "deleted_at": "2023-11-07T05:31:56Z",
  "insurance_company_id": 123,
  "redirect_url": "<string>",
  "hidden_meta_data": {},
  "uploaded_at": "2023-11-07T05:31:56Z",
  "policy_url": "<string>",
  "invoice_url": "<string>"
}

POST

policies

Purchase

curl --request POST \
  --url https://sandbox.yasmina.ai/api/v1/yasmina-schengen-travel/policies \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "quote_id": "Q-L5ELL0WU",
  "redirect_url": "<string>"
}
'

{
  "id": 936,
  "meta_data": {
    "bill": {
      "items": {},
      "adminFees": 25
    },
    "email": "[email protected]",
    "price": 92,
    "duration": 10,
    "quote_id": 1,
    "start_date": "2026-02-27",
    "travellers": [
      {
        "gender": "m",
        "relation": "self",
        "full_name": "Yasmina Alex",
        "nationality": "SA",
        "date_of_birth": "1982-04-20",
        "passport_number": "G12345678",
        "passport_expiry_date": "2026-10-30"
      }
    ],
    "multi_entry": false,
    "phone_number": "+966501234567",
    "date_of_birth": "1988-04-20",
    "nationality_id": "1234567890"
  },
  "product_id": 8,
  "client_id": "a0fd456b-853d-4511-b80f-2bfdb0e66303",
  "pdf_parsed": 0,
  "has_sent_cancellation_email": 0,
  "created_at": "2026-02-03T07:12:45.000000Z",
  "updated_at": "2026-02-03T07:12:45.000000Z",
  "status": 0,
  "is_old_policy": 0,
  "payment_link": "https://sandbox.yasmina.ai/short/4OrJN",
  "price": 92,
  "canceled_at": "2023-11-07T05:31:56Z",
  "provider_policy_id": "<string>",
  "provider_policy": {},
  "start_date": "2023-12-25",
  "cancellation_document": "<string>",
  "invoice": {},
  "transfer_date_at": "2023-11-07T05:31:56Z",
  "cancellation_request_at": "2023-11-07T05:31:56Z",
  "deleted_at": "2023-11-07T05:31:56Z",
  "insurance_company_id": 123,
  "redirect_url": "<string>",
  "hidden_meta_data": {},
  "uploaded_at": "2023-11-07T05:31:56Z",
  "policy_url": "<string>",
  "invoice_url": "<string>"
}

Authorizations

Authorization

string

header

required

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

Headers

string

default:application/json

Body

application/json

quote_id

string

Example:

"Q-L5ELL0WU"

redirect_url

string<uri>

Optional URL to redirect the customer after completing payment. If provided, it must not be empty.

Minimum string length: 1

Response

200 - application/json

Successful response

integer

required

Example:

936

meta_data

object

required

Hide child attributes

meta_data.bill

object

required

Hide child attributes

meta_data.bill.items

object

required

Hide child attributes

meta_data.bill.items.{key}

object

Hide child attributes

meta_data.bill.items.{key}.count

integer

required

Example:

1

meta_data.bill.items.{key}.price

number

required

Example:

55

meta_data.bill.items.{key}.total

number

required

Example:

55

meta_data.bill.adminFees

number

required

Example:

25

meta_data.email

string<email>

required

Example:

"[email protected]"

meta_data.price

number

required

Example:

92

meta_data.duration

integer

required

Example:

10

meta_data.quote_id

integer

required

Example:

1

meta_data.start_date

string<date>

required

Example:

"2026-02-27"

meta_data.travellers

object[]

required

Hide child attributes

meta_data.travellers.gender

enum<string>

required

Available options:

m,

f

Example:

"m"

meta_data.travellers.relation

string

required

Example:

"self"

meta_data.travellers.full_name

string

required

Example:

"Yasmina Alex"

meta_data.travellers.nationality

string

required

Example:

"SA"

meta_data.travellers.date_of_birth

string<date>

required

Example:

"1982-04-20"

meta_data.travellers.passport_number

string

required

Example:

"G12345678"

meta_data.travellers.passport_expiry_date

string<date>

required

Example:

"2026-10-30"

meta_data.multi_entry

boolean

required

Example:

false

meta_data.phone_number

string

required

Example:

"+966501234567"

meta_data.date_of_birth

string<date>

required

Example:

"1988-04-20"

meta_data.nationality_id

string

required

Example:

"1234567890"

product_id

integer

required

Example:

8

client_id

string<uuid>

required

Example:

"a0fd456b-853d-4511-b80f-2bfdb0e66303"

pdf_parsed

integer

required

Example:

0

has_sent_cancellation_email

integer

required

Example:

0

created_at

string<date-time>

required

Example:

"2026-02-03T07:12:45.000000Z"

updated_at

string<date-time>

required

Example:

"2026-02-03T07:12:45.000000Z"

status

integer

required

Example:

0

is_old_policy

integer

required

Example:

0

payment_link

string<uri>

required

Example:

"https://sandbox.yasmina.ai/short/4OrJN"

price

number

required

Example:

92

canceled_at

string<date-time> | null

provider_policy_id

string | null

provider_policy

object

start_date

string<date> | null

cancellation_document

string | null

invoice

object

transfer_date_at

string<date-time> | null

cancellation_request_at

string<date-time> | null

deleted_at

string<date-time> | null

insurance_company_id

integer | null

redirect_url

string<uri> | null

hidden_meta_data

object

uploaded_at

string<date-time> | null

policy_url

string<uri> | null

invoice_url

string<uri> | null

List policies

Life S&P Products

⌘I

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

Headers

Body

Response