Request a quote for an insurance policy or product
curl --request POST \
--url https://dev.superpool.unyte.africa/api/v1/quotes \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"customer_metadata": {
"first_name": "Alex",
"last_name": "Rider",
"email": "alex.rider@example.com",
"phone": "+9988776655",
"residential_address": {
"street": "33 Motorway Avenue",
"city": "Lagos",
"state": "Lagos State",
"country": "NG",
"house_number": "33",
"postal_code": "100003"
},
"date_of_birth": "1995-02-14",
"customer_gender": "M",
"occupation": "Delivery Rider",
"identity_card_img": "https://example.com/uploads/identity_card.jpg",
"utility_bill_img": "https://example.com/uploads/utility_bill.jpg",
"identity_card_number": "DL9988776655",
"identity_card_type": "driver_license",
"identity_card_expiry_date": "2027-12-31"
},
"insurance_details": {
"product_type": "Gadget",
"additional_information": {
"gadget_type": "Smartphone",
"gadget_value": 1000000,
"gadget_information": {},
"usage_history": {},
"insurance_options": "Device Policy"
}
},
"coverage_preferences": {}
}
'import requests
url = "https://dev.superpool.unyte.africa/api/v1/quotes"
payload = {
"customer_metadata": {
"first_name": "Alex",
"last_name": "Rider",
"email": "alex.rider@example.com",
"phone": "+9988776655",
"residential_address": {
"street": "33 Motorway Avenue",
"city": "Lagos",
"state": "Lagos State",
"country": "NG",
"house_number": "33",
"postal_code": "100003"
},
"date_of_birth": "1995-02-14",
"customer_gender": "M",
"occupation": "Delivery Rider",
"identity_card_img": "https://example.com/uploads/identity_card.jpg",
"utility_bill_img": "https://example.com/uploads/utility_bill.jpg",
"identity_card_number": "DL9988776655",
"identity_card_type": "driver_license",
"identity_card_expiry_date": "2027-12-31"
},
"insurance_details": {
"product_type": "Gadget",
"additional_information": {
"gadget_type": "Smartphone",
"gadget_value": 1000000,
"gadget_information": {},
"usage_history": {},
"insurance_options": "Device Policy"
}
},
"coverage_preferences": {}
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
customer_metadata: {
first_name: 'Alex',
last_name: 'Rider',
email: 'alex.rider@example.com',
phone: '+9988776655',
residential_address: {
street: '33 Motorway Avenue',
city: 'Lagos',
state: 'Lagos State',
country: 'NG',
house_number: '33',
postal_code: '100003'
},
date_of_birth: '1995-02-14',
customer_gender: 'M',
occupation: 'Delivery Rider',
identity_card_img: 'https://example.com/uploads/identity_card.jpg',
utility_bill_img: 'https://example.com/uploads/utility_bill.jpg',
identity_card_number: 'DL9988776655',
identity_card_type: 'driver_license',
identity_card_expiry_date: '2027-12-31'
},
insurance_details: {
product_type: 'Gadget',
additional_information: {
gadget_type: 'Smartphone',
gadget_value: 1000000,
gadget_information: {},
usage_history: {},
insurance_options: 'Device Policy'
}
},
coverage_preferences: {}
})
};
fetch('https://dev.superpool.unyte.africa/api/v1/quotes', 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://dev.superpool.unyte.africa/api/v1/quotes",
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([
'customer_metadata' => [
'first_name' => 'Alex',
'last_name' => 'Rider',
'email' => 'alex.rider@example.com',
'phone' => '+9988776655',
'residential_address' => [
'street' => '33 Motorway Avenue',
'city' => 'Lagos',
'state' => 'Lagos State',
'country' => 'NG',
'house_number' => '33',
'postal_code' => '100003'
],
'date_of_birth' => '1995-02-14',
'customer_gender' => 'M',
'occupation' => 'Delivery Rider',
'identity_card_img' => 'https://example.com/uploads/identity_card.jpg',
'utility_bill_img' => 'https://example.com/uploads/utility_bill.jpg',
'identity_card_number' => 'DL9988776655',
'identity_card_type' => 'driver_license',
'identity_card_expiry_date' => '2027-12-31'
],
'insurance_details' => [
'product_type' => 'Gadget',
'additional_information' => [
'gadget_type' => 'Smartphone',
'gadget_value' => 1000000,
'gadget_information' => [
],
'usage_history' => [
],
'insurance_options' => 'Device Policy'
]
],
'coverage_preferences' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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://dev.superpool.unyte.africa/api/v1/quotes"
payload := strings.NewReader("{\n \"customer_metadata\": {\n \"first_name\": \"Alex\",\n \"last_name\": \"Rider\",\n \"email\": \"alex.rider@example.com\",\n \"phone\": \"+9988776655\",\n \"residential_address\": {\n \"street\": \"33 Motorway Avenue\",\n \"city\": \"Lagos\",\n \"state\": \"Lagos State\",\n \"country\": \"NG\",\n \"house_number\": \"33\",\n \"postal_code\": \"100003\"\n },\n \"date_of_birth\": \"1995-02-14\",\n \"customer_gender\": \"M\",\n \"occupation\": \"Delivery Rider\",\n \"identity_card_img\": \"https://example.com/uploads/identity_card.jpg\",\n \"utility_bill_img\": \"https://example.com/uploads/utility_bill.jpg\",\n \"identity_card_number\": \"DL9988776655\",\n \"identity_card_type\": \"driver_license\",\n \"identity_card_expiry_date\": \"2027-12-31\"\n },\n \"insurance_details\": {\n \"product_type\": \"Gadget\",\n \"additional_information\": {\n \"gadget_type\": \"Smartphone\",\n \"gadget_value\": 1000000,\n \"gadget_information\": {},\n \"usage_history\": {},\n \"insurance_options\": \"Device Policy\"\n }\n },\n \"coverage_preferences\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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://dev.superpool.unyte.africa/api/v1/quotes")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"customer_metadata\": {\n \"first_name\": \"Alex\",\n \"last_name\": \"Rider\",\n \"email\": \"alex.rider@example.com\",\n \"phone\": \"+9988776655\",\n \"residential_address\": {\n \"street\": \"33 Motorway Avenue\",\n \"city\": \"Lagos\",\n \"state\": \"Lagos State\",\n \"country\": \"NG\",\n \"house_number\": \"33\",\n \"postal_code\": \"100003\"\n },\n \"date_of_birth\": \"1995-02-14\",\n \"customer_gender\": \"M\",\n \"occupation\": \"Delivery Rider\",\n \"identity_card_img\": \"https://example.com/uploads/identity_card.jpg\",\n \"utility_bill_img\": \"https://example.com/uploads/utility_bill.jpg\",\n \"identity_card_number\": \"DL9988776655\",\n \"identity_card_type\": \"driver_license\",\n \"identity_card_expiry_date\": \"2027-12-31\"\n },\n \"insurance_details\": {\n \"product_type\": \"Gadget\",\n \"additional_information\": {\n \"gadget_type\": \"Smartphone\",\n \"gadget_value\": 1000000,\n \"gadget_information\": {},\n \"usage_history\": {},\n \"insurance_options\": \"Device Policy\"\n }\n },\n \"coverage_preferences\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://dev.superpool.unyte.africa/api/v1/quotes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"customer_metadata\": {\n \"first_name\": \"Alex\",\n \"last_name\": \"Rider\",\n \"email\": \"alex.rider@example.com\",\n \"phone\": \"+9988776655\",\n \"residential_address\": {\n \"street\": \"33 Motorway Avenue\",\n \"city\": \"Lagos\",\n \"state\": \"Lagos State\",\n \"country\": \"NG\",\n \"house_number\": \"33\",\n \"postal_code\": \"100003\"\n },\n \"date_of_birth\": \"1995-02-14\",\n \"customer_gender\": \"M\",\n \"occupation\": \"Delivery Rider\",\n \"identity_card_img\": \"https://example.com/uploads/identity_card.jpg\",\n \"utility_bill_img\": \"https://example.com/uploads/utility_bill.jpg\",\n \"identity_card_number\": \"DL9988776655\",\n \"identity_card_type\": \"driver_license\",\n \"identity_card_expiry_date\": \"2027-12-31\"\n },\n \"insurance_details\": {\n \"product_type\": \"Gadget\",\n \"additional_information\": {\n \"gadget_type\": \"Smartphone\",\n \"gadget_value\": 1000000,\n \"gadget_information\": {},\n \"usage_history\": {},\n \"insurance_options\": \"Device Policy\"\n }\n },\n \"coverage_preferences\": {}\n}"
response = http.request(request)
puts response.read_body[
{
"count": 5,
"next": "http://example.com/api/v1/quotes/?limit=2",
"previous": "http://example.com/api/v1/quotes/?offset=1",
"results": [
{
"quote_code": "Quo_i61y3_55a7f6c7",
"provider": "Xample Insurance",
"product": "POS Insurance",
"product_type": "Gadget",
"base_price": "100000.00",
"premium": "100000.00",
"purchase_id": "PUR-59d61d6b-1547-4fda-9420-ee8cfd1dace4",
"additional_metadata": {
"device_type": "POS",
"device_make": "Opay POS"
}
},
{
"quote_code": "Quo_85ahq_c96ced02",
"provider": "Heirs Insurance Group",
"product": "MegaProtect Device Policy",
"product_type": "Gadget",
"base_price": "100000.00",
"premium": "100000.00",
"purchase_id": "PUR-07d71432-c587-45fc-8693-189eafe4db5e",
"additional_metadata": {
"device_type": "Smartphone",
"device_make": "Samsung",
"device_model": "Galaxy S21",
"device_value": "100000.00"
}
}
]
}
]Quotes
Request a quote for an insurance policy or product
Submit a request to generate insurance quotes for a specified product type and customer details. Allows filtering by provider, coverage type, and sorting.
POST
/
api
/
v1
/
quotes
Request a quote for an insurance policy or product
curl --request POST \
--url https://dev.superpool.unyte.africa/api/v1/quotes \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"customer_metadata": {
"first_name": "Alex",
"last_name": "Rider",
"email": "alex.rider@example.com",
"phone": "+9988776655",
"residential_address": {
"street": "33 Motorway Avenue",
"city": "Lagos",
"state": "Lagos State",
"country": "NG",
"house_number": "33",
"postal_code": "100003"
},
"date_of_birth": "1995-02-14",
"customer_gender": "M",
"occupation": "Delivery Rider",
"identity_card_img": "https://example.com/uploads/identity_card.jpg",
"utility_bill_img": "https://example.com/uploads/utility_bill.jpg",
"identity_card_number": "DL9988776655",
"identity_card_type": "driver_license",
"identity_card_expiry_date": "2027-12-31"
},
"insurance_details": {
"product_type": "Gadget",
"additional_information": {
"gadget_type": "Smartphone",
"gadget_value": 1000000,
"gadget_information": {},
"usage_history": {},
"insurance_options": "Device Policy"
}
},
"coverage_preferences": {}
}
'import requests
url = "https://dev.superpool.unyte.africa/api/v1/quotes"
payload = {
"customer_metadata": {
"first_name": "Alex",
"last_name": "Rider",
"email": "alex.rider@example.com",
"phone": "+9988776655",
"residential_address": {
"street": "33 Motorway Avenue",
"city": "Lagos",
"state": "Lagos State",
"country": "NG",
"house_number": "33",
"postal_code": "100003"
},
"date_of_birth": "1995-02-14",
"customer_gender": "M",
"occupation": "Delivery Rider",
"identity_card_img": "https://example.com/uploads/identity_card.jpg",
"utility_bill_img": "https://example.com/uploads/utility_bill.jpg",
"identity_card_number": "DL9988776655",
"identity_card_type": "driver_license",
"identity_card_expiry_date": "2027-12-31"
},
"insurance_details": {
"product_type": "Gadget",
"additional_information": {
"gadget_type": "Smartphone",
"gadget_value": 1000000,
"gadget_information": {},
"usage_history": {},
"insurance_options": "Device Policy"
}
},
"coverage_preferences": {}
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
customer_metadata: {
first_name: 'Alex',
last_name: 'Rider',
email: 'alex.rider@example.com',
phone: '+9988776655',
residential_address: {
street: '33 Motorway Avenue',
city: 'Lagos',
state: 'Lagos State',
country: 'NG',
house_number: '33',
postal_code: '100003'
},
date_of_birth: '1995-02-14',
customer_gender: 'M',
occupation: 'Delivery Rider',
identity_card_img: 'https://example.com/uploads/identity_card.jpg',
utility_bill_img: 'https://example.com/uploads/utility_bill.jpg',
identity_card_number: 'DL9988776655',
identity_card_type: 'driver_license',
identity_card_expiry_date: '2027-12-31'
},
insurance_details: {
product_type: 'Gadget',
additional_information: {
gadget_type: 'Smartphone',
gadget_value: 1000000,
gadget_information: {},
usage_history: {},
insurance_options: 'Device Policy'
}
},
coverage_preferences: {}
})
};
fetch('https://dev.superpool.unyte.africa/api/v1/quotes', 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://dev.superpool.unyte.africa/api/v1/quotes",
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([
'customer_metadata' => [
'first_name' => 'Alex',
'last_name' => 'Rider',
'email' => 'alex.rider@example.com',
'phone' => '+9988776655',
'residential_address' => [
'street' => '33 Motorway Avenue',
'city' => 'Lagos',
'state' => 'Lagos State',
'country' => 'NG',
'house_number' => '33',
'postal_code' => '100003'
],
'date_of_birth' => '1995-02-14',
'customer_gender' => 'M',
'occupation' => 'Delivery Rider',
'identity_card_img' => 'https://example.com/uploads/identity_card.jpg',
'utility_bill_img' => 'https://example.com/uploads/utility_bill.jpg',
'identity_card_number' => 'DL9988776655',
'identity_card_type' => 'driver_license',
'identity_card_expiry_date' => '2027-12-31'
],
'insurance_details' => [
'product_type' => 'Gadget',
'additional_information' => [
'gadget_type' => 'Smartphone',
'gadget_value' => 1000000,
'gadget_information' => [
],
'usage_history' => [
],
'insurance_options' => 'Device Policy'
]
],
'coverage_preferences' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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://dev.superpool.unyte.africa/api/v1/quotes"
payload := strings.NewReader("{\n \"customer_metadata\": {\n \"first_name\": \"Alex\",\n \"last_name\": \"Rider\",\n \"email\": \"alex.rider@example.com\",\n \"phone\": \"+9988776655\",\n \"residential_address\": {\n \"street\": \"33 Motorway Avenue\",\n \"city\": \"Lagos\",\n \"state\": \"Lagos State\",\n \"country\": \"NG\",\n \"house_number\": \"33\",\n \"postal_code\": \"100003\"\n },\n \"date_of_birth\": \"1995-02-14\",\n \"customer_gender\": \"M\",\n \"occupation\": \"Delivery Rider\",\n \"identity_card_img\": \"https://example.com/uploads/identity_card.jpg\",\n \"utility_bill_img\": \"https://example.com/uploads/utility_bill.jpg\",\n \"identity_card_number\": \"DL9988776655\",\n \"identity_card_type\": \"driver_license\",\n \"identity_card_expiry_date\": \"2027-12-31\"\n },\n \"insurance_details\": {\n \"product_type\": \"Gadget\",\n \"additional_information\": {\n \"gadget_type\": \"Smartphone\",\n \"gadget_value\": 1000000,\n \"gadget_information\": {},\n \"usage_history\": {},\n \"insurance_options\": \"Device Policy\"\n }\n },\n \"coverage_preferences\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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://dev.superpool.unyte.africa/api/v1/quotes")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"customer_metadata\": {\n \"first_name\": \"Alex\",\n \"last_name\": \"Rider\",\n \"email\": \"alex.rider@example.com\",\n \"phone\": \"+9988776655\",\n \"residential_address\": {\n \"street\": \"33 Motorway Avenue\",\n \"city\": \"Lagos\",\n \"state\": \"Lagos State\",\n \"country\": \"NG\",\n \"house_number\": \"33\",\n \"postal_code\": \"100003\"\n },\n \"date_of_birth\": \"1995-02-14\",\n \"customer_gender\": \"M\",\n \"occupation\": \"Delivery Rider\",\n \"identity_card_img\": \"https://example.com/uploads/identity_card.jpg\",\n \"utility_bill_img\": \"https://example.com/uploads/utility_bill.jpg\",\n \"identity_card_number\": \"DL9988776655\",\n \"identity_card_type\": \"driver_license\",\n \"identity_card_expiry_date\": \"2027-12-31\"\n },\n \"insurance_details\": {\n \"product_type\": \"Gadget\",\n \"additional_information\": {\n \"gadget_type\": \"Smartphone\",\n \"gadget_value\": 1000000,\n \"gadget_information\": {},\n \"usage_history\": {},\n \"insurance_options\": \"Device Policy\"\n }\n },\n \"coverage_preferences\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://dev.superpool.unyte.africa/api/v1/quotes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"customer_metadata\": {\n \"first_name\": \"Alex\",\n \"last_name\": \"Rider\",\n \"email\": \"alex.rider@example.com\",\n \"phone\": \"+9988776655\",\n \"residential_address\": {\n \"street\": \"33 Motorway Avenue\",\n \"city\": \"Lagos\",\n \"state\": \"Lagos State\",\n \"country\": \"NG\",\n \"house_number\": \"33\",\n \"postal_code\": \"100003\"\n },\n \"date_of_birth\": \"1995-02-14\",\n \"customer_gender\": \"M\",\n \"occupation\": \"Delivery Rider\",\n \"identity_card_img\": \"https://example.com/uploads/identity_card.jpg\",\n \"utility_bill_img\": \"https://example.com/uploads/utility_bill.jpg\",\n \"identity_card_number\": \"DL9988776655\",\n \"identity_card_type\": \"driver_license\",\n \"identity_card_expiry_date\": \"2027-12-31\"\n },\n \"insurance_details\": {\n \"product_type\": \"Gadget\",\n \"additional_information\": {\n \"gadget_type\": \"Smartphone\",\n \"gadget_value\": 1000000,\n \"gadget_information\": {},\n \"usage_history\": {},\n \"insurance_options\": \"Device Policy\"\n }\n },\n \"coverage_preferences\": {}\n}"
response = http.request(request)
puts response.read_body[
{
"count": 5,
"next": "http://example.com/api/v1/quotes/?limit=2",
"previous": "http://example.com/api/v1/quotes/?offset=1",
"results": [
{
"quote_code": "Quo_i61y3_55a7f6c7",
"provider": "Xample Insurance",
"product": "POS Insurance",
"product_type": "Gadget",
"base_price": "100000.00",
"premium": "100000.00",
"purchase_id": "PUR-59d61d6b-1547-4fda-9420-ee8cfd1dace4",
"additional_metadata": {
"device_type": "POS",
"device_make": "Opay POS"
}
},
{
"quote_code": "Quo_85ahq_c96ced02",
"provider": "Heirs Insurance Group",
"product": "MegaProtect Device Policy",
"product_type": "Gadget",
"base_price": "100000.00",
"premium": "100000.00",
"purchase_id": "PUR-07d71432-c587-45fc-8693-189eafe4db5e",
"additional_metadata": {
"device_type": "Smartphone",
"device_make": "Samsung",
"device_model": "Galaxy S21",
"device_value": "100000.00"
}
}
]
}
]Authorizations
Body
application/jsonapplication/x-www-form-urlencodedmultipart/form-data
Quotes 2.0
Revised serializer for handling incoming quote requests for different product tiers and insurance details.
Identifies the type of insurance product being requested
Show child attributes
Show child attributes
Captures essential personal information about the applicant
Show child attributes
Show child attributes
Captures the applicant's desired coverage options
It captures what type of coverage the applicant is interested in (e.g., comprehensive or liability) and their preferred deductible amount. Additional coverages can also be specified here.
Show child attributes
Show child attributes
Response
200 - application/json
The response contains a list of available quotes from different providers.
Assigned identifier for managing quote objects
Price estimate of insurance product for default tenure excluding any adjustments
Pattern:
^-?\d{0,8}(?:\.\d{0,2})?$Available tenure durations for this insurance product with their prices
Show child attributes
Show child attributes
Additional information about the quote