Issue the policy

Issue the policy

curl --request POST \
  --url https://production.yasmina.ai/api/v1/medical/policies \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "quote_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "quote_price_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://production.yasmina.ai/api/v1/medical/policies"

payload = {
    "quote_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "quote_price_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    quote_request_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    quote_price_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://production.yasmina.ai/api/v1/medical/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://production.yasmina.ai/api/v1/medical/policies",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'quote_request_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'quote_price_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://production.yasmina.ai/api/v1/medical/policies"

	payload := strings.NewReader("{\n  \"quote_request_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"quote_price_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://production.yasmina.ai/api/v1/medical/policies")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"quote_request_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"quote_price_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://production.yasmina.ai/api/v1/medical/policies")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"quote_request_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"quote_price_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

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

{
  "id": 123,
  "status": 123,
  "price": 123,
  "pending_declarations": [
    "<string>"
  ],
  "payment_link": "<string>",
  "provider_policy_id": "<string>",
  "policy_url": "<string>",
  "invoice_url": "<string>",
  "redirect_url": "<string>",
  "meta_data": {
    "company_id": 123,
    "insurance_provider": "<string>",
    "quote_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "quote_price_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "insured": [
      {
        "name": "<string>",
        "nationality_iso": "<string>",
        "category": "basic",
        "mobile_number": "0500000001",
        "date_of_birth": "<string>",
        "nationality_id": "1111111111",
        "iqama_id": "2222222222",
        "border_number": "3000000001",
        "sponsor_id": "1000000001",
        "is_married": true,
        "dependents": [
          {
            "name": "<string>",
            "relationship": "spouse",
            "nationality_iso": "<string>",
            "date_of_birth": "<string>",
            "nationality_id": "1111111112",
            "iqama_id": "2222222222"
          }
        ],
        "health_declaration": {
          "answers": {
            "allergies": "Yes",
            "current_medications": "Yes",
            "hospitalizations": "Yes",
            "pre_existing_conditions": "Yes",
            "past_surgeries": "Yes",
            "surgery_complications": "Yes",
            "chest_pain_or_breathlessness": "Yes",
            "heart_procedures": "Yes",
            "smoking": "Yes",
            "alcohol_consumption": "Yes",
            "physical_activity": "Yes",
            "family_history": "Yes",
            "chronic_disease": [
              "Diabetes"
            ]
          },
          "consent": true,
          "filled_at": "2023-11-07T05:31:56Z"
        }
      }
    ]
  }
}

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

{
  "code": "<string>",
  "message": "<string>"
}

POST

policies

Issue the policy

curl --request POST \
  --url https://production.yasmina.ai/api/v1/medical/policies \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "quote_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "quote_price_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://production.yasmina.ai/api/v1/medical/policies"

payload = {
    "quote_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "quote_price_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    quote_request_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    quote_price_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://production.yasmina.ai/api/v1/medical/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://production.yasmina.ai/api/v1/medical/policies",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'quote_request_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'quote_price_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://production.yasmina.ai/api/v1/medical/policies"

	payload := strings.NewReader("{\n  \"quote_request_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"quote_price_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://production.yasmina.ai/api/v1/medical/policies")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"quote_request_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"quote_price_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://production.yasmina.ai/api/v1/medical/policies")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"quote_request_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"quote_price_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

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

{
  "id": 123,
  "status": 123,
  "price": 123,
  "pending_declarations": [
    "<string>"
  ],
  "payment_link": "<string>",
  "provider_policy_id": "<string>",
  "policy_url": "<string>",
  "invoice_url": "<string>",
  "redirect_url": "<string>",
  "meta_data": {
    "company_id": 123,
    "insurance_provider": "<string>",
    "quote_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "quote_price_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "insured": [
      {
        "name": "<string>",
        "nationality_iso": "<string>",
        "category": "basic",
        "mobile_number": "0500000001",
        "date_of_birth": "<string>",
        "nationality_id": "1111111111",
        "iqama_id": "2222222222",
        "border_number": "3000000001",
        "sponsor_id": "1000000001",
        "is_married": true,
        "dependents": [
          {
            "name": "<string>",
            "relationship": "spouse",
            "nationality_iso": "<string>",
            "date_of_birth": "<string>",
            "nationality_id": "1111111112",
            "iqama_id": "2222222222"
          }
        ],
        "health_declaration": {
          "answers": {
            "allergies": "Yes",
            "current_medications": "Yes",
            "hospitalizations": "Yes",
            "pre_existing_conditions": "Yes",
            "past_surgeries": "Yes",
            "surgery_complications": "Yes",
            "chest_pain_or_breathlessness": "Yes",
            "heart_procedures": "Yes",
            "smoking": "Yes",
            "alcohol_consumption": "Yes",
            "physical_activity": "Yes",
            "family_history": "Yes",
            "chronic_disease": [
              "Diabetes"
            ]
          },
          "consent": true,
          "filled_at": "2023-11-07T05:31:56Z"
        }
      }
    ]
  }
}

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

{
  "code": "<string>",
  "message": "<string>"
}

Authorizations

Authorization

string

header

required

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

Body

application/json

quote_request_id

string<uuid>

required

The id of the quote request.

quote_price_id

string<uuid>

required

The quote_price_id of the chosen provider's quote.

redirect_url

string

Where to send the customer once they have paid. policyID in it is replaced with the policy's id.

Example:

"https://www.example.com?yasmina_policy_id=policyID"

Response

The company's policy, pending payment

integer

status

integer

0 pending payment, 1 active, 2 cancelled.

price

number

The premium for everyone on the policy, for a year.

pending_declarations

string[]

Employees who still have to declare their medical history. Empty once everyone has.

payment_link

string | null

Where the company pays. A fresh signed link on every read, valid 15 minutes. Null while anyone is in pending_declarations, and once the policy is issued.

provider_policy_id

string | null

The insurer's policy number, once issued.

policy_url

string | null

The policy schedule listing every member, once the company has paid. Null before that.

invoice_url

string | null

The invoice for the premium the company paid, one line per package tier, once the company has paid. Null before that. On sandbox the document is watermarked SANDBOX and is not a tax invoice.

redirect_url

string | null

meta_data

object

Hide child attributes

meta_data.company_id

integer

meta_data.insurance_provider

string

meta_data.quote_request_id

string<uuid>

meta_data.quote_price_id

string<uuid>

meta_data.insured

object[]

Hide child attributes

meta_data.insured.name

string

required

meta_data.insured.nationality_iso

string

required

meta_data.insured.category

enum<string>

required

The tier this employee picked. Every provider sells all four, so the quote request can price it with each of them.

Available options:

basic,

standard,

premium,

executive

meta_data.insured.mobile_number

string

required

The employee's mobile number.

Example:

"0500000001"

meta_data.insured.date_of_birth

string

required

Format YYYY-MM-DD. Saudi nationals whose national id starts with 1 give the Hijri (Umm al-Qura) date printed on their id, for example 1409-09-14; everyone else gives a Gregorian date. Employees must be between 18 and 110 years old.

meta_data.insured.nationality_id

string

For Saudis only. Exactly 10 digits.

Pattern: ^[0-9]{10}$

Example:

"1111111111"

meta_data.insured.iqama_id

string

For non-Saudis. Exactly 10 digits. A non-Saudi whose iqama is not issued yet sends border_number instead.

Pattern: ^[0-9]{10}$

Example:

"2222222222"

meta_data.insured.border_number

string

For non-Saudis without an iqama yet, in place of iqama_id. Exactly 10 digits.

Pattern: ^[0-9]{10}$

Example:

"3000000001"

The employee's sponsor id. Optional. Exactly 10 digits.

Pattern: ^[0-9]{10}$

Example:

"1000000001"

meta_data.insured.is_married

boolean

Whether the employee is married. Optional.

Example:

true

meta_data.insured.dependents

object[]

Family members covered under this employee's policy. They get the same provider and category as the employee. Optional; omit or send an empty array for an employee without dependents.

Hide child attributes

meta_data.insured.dependents.name

string

required

meta_data.insured.dependents.relationship

enum<string>

required

How the dependent is related to the employee

Available options:

spouse,

child,

parent

meta_data.insured.dependents.nationality_iso

string

required

ISO 3166-1 alpha-2 country code

meta_data.insured.dependents.date_of_birth

string

required

meta_data.insured.dependents.nationality_id

string

Required when nationality_iso is SA. Exactly 10 digits.

Pattern: ^[0-9]{10}$

Example:

"1111111112"

meta_data.insured.dependents.iqama_id

string

Required when nationality_iso is not SA. Exactly 10 digits.

Pattern: ^[0-9]{10}$

Example:

"2222222222"

meta_data.insured.health_declaration

object

read-only

The employee's declaration, on the employees of a quote request and a policy. Set through Submit the declarations; ignored when sent in.

Hide child attributes

meta_data.insured.health_declaration.answers

object

Yes or No for each question, and the list of chronic diseases.

Hide child attributes

meta_data.insured.health_declaration.answers.allergies

enum<string>

Available options:

Yes,

No

meta_data.insured.health_declaration.answers.current_medications

enum<string>

Available options:

Yes,

No

meta_data.insured.health_declaration.answers.hospitalizations

enum<string>

Available options:

Yes,

No

meta_data.insured.health_declaration.answers.pre_existing_conditions

enum<string>

Available options:

Yes,

No

meta_data.insured.health_declaration.answers.past_surgeries

enum<string>

Available options:

Yes,

No

meta_data.insured.health_declaration.answers.surgery_complications

enum<string>

Available options:

Yes,

No

meta_data.insured.health_declaration.answers.chest_pain_or_breathlessness

enum<string>

Available options:

Yes,

No

meta_data.insured.health_declaration.answers.heart_procedures

enum<string>

Available options:

Yes,

No

meta_data.insured.health_declaration.answers.smoking

enum<string>

Available options:

Yes,

No

meta_data.insured.health_declaration.answers.alcohol_consumption

enum<string>

Available options:

Yes,

No

meta_data.insured.health_declaration.answers.physical_activity

enum<string>

Available options:

Yes,

No

meta_data.insured.health_declaration.answers.family_history

enum<string>

Available options:

Yes,

No

meta_data.insured.health_declaration.answers.chronic_disease

enum<string>[]

Available options:

Diabetes,

Asthma,

Chronic Kidney Disease,

Liver Disease,

Cancer,

None of the above

Available options:

true

meta_data.insured.health_declaration.filled_at

string<date-time>

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

Body

Response