Save the employees
curl --request PUT \
--url https://production.yasmina.ai/api/v1/medical/companies/{companyId}/employees \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"employees": [
{
"name": "<string>",
"nationality_iso": "<string>",
"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>",
"nationality_iso": "<string>",
"date_of_birth": "<string>",
"nationality_id": "1111111112",
"iqama_id": "2222222222"
}
]
}
]
}
'import requests
url = "https://production.yasmina.ai/api/v1/medical/companies/{companyId}/employees"
payload = { "employees": [
{
"name": "<string>",
"nationality_iso": "<string>",
"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>",
"nationality_iso": "<string>",
"date_of_birth": "<string>",
"nationality_id": "1111111112",
"iqama_id": "2222222222"
}
]
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
employees: [
{
name: '<string>',
nationality_iso: '<string>',
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>',
nationality_iso: '<string>',
date_of_birth: '<string>',
nationality_id: '1111111112',
iqama_id: '2222222222'
}
]
}
]
})
};
fetch('https://production.yasmina.ai/api/v1/medical/companies/{companyId}/employees', 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/companies/{companyId}/employees",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'employees' => [
[
'name' => '<string>',
'nationality_iso' => '<string>',
'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>',
'nationality_iso' => '<string>',
'date_of_birth' => '<string>',
'nationality_id' => '1111111112',
'iqama_id' => '2222222222'
]
]
]
]
]),
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/companies/{companyId}/employees"
payload := strings.NewReader("{\n \"employees\": [\n {\n \"name\": \"<string>\",\n \"nationality_iso\": \"<string>\",\n \"mobile_number\": \"0500000001\",\n \"date_of_birth\": \"<string>\",\n \"nationality_id\": \"1111111111\",\n \"iqama_id\": \"2222222222\",\n \"border_number\": \"3000000001\",\n \"sponsor_id\": \"1000000001\",\n \"is_married\": true,\n \"dependents\": [\n {\n \"name\": \"<string>\",\n \"nationality_iso\": \"<string>\",\n \"date_of_birth\": \"<string>\",\n \"nationality_id\": \"1111111112\",\n \"iqama_id\": \"2222222222\"\n }\n ]\n }\n ]\n}")
req, _ := http.NewRequest("PUT", 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.put("https://production.yasmina.ai/api/v1/medical/companies/{companyId}/employees")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"employees\": [\n {\n \"name\": \"<string>\",\n \"nationality_iso\": \"<string>\",\n \"mobile_number\": \"0500000001\",\n \"date_of_birth\": \"<string>\",\n \"nationality_id\": \"1111111111\",\n \"iqama_id\": \"2222222222\",\n \"border_number\": \"3000000001\",\n \"sponsor_id\": \"1000000001\",\n \"is_married\": true,\n \"dependents\": [\n {\n \"name\": \"<string>\",\n \"nationality_iso\": \"<string>\",\n \"date_of_birth\": \"<string>\",\n \"nationality_id\": \"1111111112\",\n \"iqama_id\": \"2222222222\"\n }\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://production.yasmina.ai/api/v1/medical/companies/{companyId}/employees")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"employees\": [\n {\n \"name\": \"<string>\",\n \"nationality_iso\": \"<string>\",\n \"mobile_number\": \"0500000001\",\n \"date_of_birth\": \"<string>\",\n \"nationality_id\": \"1111111111\",\n \"iqama_id\": \"2222222222\",\n \"border_number\": \"3000000001\",\n \"sponsor_id\": \"1000000001\",\n \"is_married\": true,\n \"dependents\": [\n {\n \"name\": \"<string>\",\n \"nationality_iso\": \"<string>\",\n \"date_of_birth\": \"<string>\",\n \"nationality_id\": \"1111111112\",\n \"iqama_id\": \"2222222222\"\n }\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"code": "40101",
"message": "Unauthenticated"
}{
"code": "<string>",
"message": "<string>"
}Save the employees
Replaces the company’s employee list with the one given: who is covered, their dependents, and the tier each has picked (basic, standard, premium or executive). Use it to edit or remove employees after fetching the list. An employee who stays on the list keeps their health declaration. Nothing is priced here; see Get prices from every provider.
PUT
/
companies
/
{companyId}
/
employees
Save the employees
curl --request PUT \
--url https://production.yasmina.ai/api/v1/medical/companies/{companyId}/employees \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"employees": [
{
"name": "<string>",
"nationality_iso": "<string>",
"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>",
"nationality_iso": "<string>",
"date_of_birth": "<string>",
"nationality_id": "1111111112",
"iqama_id": "2222222222"
}
]
}
]
}
'import requests
url = "https://production.yasmina.ai/api/v1/medical/companies/{companyId}/employees"
payload = { "employees": [
{
"name": "<string>",
"nationality_iso": "<string>",
"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>",
"nationality_iso": "<string>",
"date_of_birth": "<string>",
"nationality_id": "1111111112",
"iqama_id": "2222222222"
}
]
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
employees: [
{
name: '<string>',
nationality_iso: '<string>',
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>',
nationality_iso: '<string>',
date_of_birth: '<string>',
nationality_id: '1111111112',
iqama_id: '2222222222'
}
]
}
]
})
};
fetch('https://production.yasmina.ai/api/v1/medical/companies/{companyId}/employees', 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/companies/{companyId}/employees",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'employees' => [
[
'name' => '<string>',
'nationality_iso' => '<string>',
'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>',
'nationality_iso' => '<string>',
'date_of_birth' => '<string>',
'nationality_id' => '1111111112',
'iqama_id' => '2222222222'
]
]
]
]
]),
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/companies/{companyId}/employees"
payload := strings.NewReader("{\n \"employees\": [\n {\n \"name\": \"<string>\",\n \"nationality_iso\": \"<string>\",\n \"mobile_number\": \"0500000001\",\n \"date_of_birth\": \"<string>\",\n \"nationality_id\": \"1111111111\",\n \"iqama_id\": \"2222222222\",\n \"border_number\": \"3000000001\",\n \"sponsor_id\": \"1000000001\",\n \"is_married\": true,\n \"dependents\": [\n {\n \"name\": \"<string>\",\n \"nationality_iso\": \"<string>\",\n \"date_of_birth\": \"<string>\",\n \"nationality_id\": \"1111111112\",\n \"iqama_id\": \"2222222222\"\n }\n ]\n }\n ]\n}")
req, _ := http.NewRequest("PUT", 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.put("https://production.yasmina.ai/api/v1/medical/companies/{companyId}/employees")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"employees\": [\n {\n \"name\": \"<string>\",\n \"nationality_iso\": \"<string>\",\n \"mobile_number\": \"0500000001\",\n \"date_of_birth\": \"<string>\",\n \"nationality_id\": \"1111111111\",\n \"iqama_id\": \"2222222222\",\n \"border_number\": \"3000000001\",\n \"sponsor_id\": \"1000000001\",\n \"is_married\": true,\n \"dependents\": [\n {\n \"name\": \"<string>\",\n \"nationality_iso\": \"<string>\",\n \"date_of_birth\": \"<string>\",\n \"nationality_id\": \"1111111112\",\n \"iqama_id\": \"2222222222\"\n }\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://production.yasmina.ai/api/v1/medical/companies/{companyId}/employees")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"employees\": [\n {\n \"name\": \"<string>\",\n \"nationality_iso\": \"<string>\",\n \"mobile_number\": \"0500000001\",\n \"date_of_birth\": \"<string>\",\n \"nationality_id\": \"1111111111\",\n \"iqama_id\": \"2222222222\",\n \"border_number\": \"3000000001\",\n \"sponsor_id\": \"1000000001\",\n \"is_married\": true,\n \"dependents\": [\n {\n \"name\": \"<string>\",\n \"nationality_iso\": \"<string>\",\n \"date_of_birth\": \"<string>\",\n \"nationality_id\": \"1111111112\",\n \"iqama_id\": \"2222222222\"\n }\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"code": "40101",
"message": "Unauthenticated"
}{
"code": "<string>",
"message": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
application/json
Minimum array length:
1Hide child attributes
Hide child attributes
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 The employee's mobile number.
Example:
"0500000001"
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.
For Saudis only. Exactly 10 digits.
Pattern:
^[0-9]{10}$Example:
"1111111111"
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"
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"
Whether the employee is married. Optional.
Example:
true
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
Hide child attributes
How the dependent is related to the employee
Available options:
spouse, child, parent ISO 3166-1 alpha-2 country code
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. A dependent can be any age up to 110.
Required when nationality_iso is SA. Exactly 10 digits.
Pattern:
^[0-9]{10}$Example:
"1111111112"
Required when nationality_iso is not SA. Exactly 10 digits.
Pattern:
^[0-9]{10}$Example:
"2222222222"
Response
The saved list
⌘I