Skip to main content
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": {}
}
'
[
  {
    "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

​
X-API-Key
string
header
required

Body

Quotes 2.0

Revised serializer for handling incoming quote requests for different product tiers and insurance details.

​
insurance_details
object
required

Identifies the type of insurance product being requested

​
customer_metadata
object

Captures essential personal information about the applicant

​
coverage_preferences
object

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.

Response

200 - application/json

The response contains a list of available quotes from different providers.

​
quote_code
string
required
read-only

Assigned identifier for managing quote objects

​
provider
string
required
​
product
string
required
​
product_type
string
required
​
base_price
string<decimal>
required

Price estimate of insurance product for default tenure excluding any adjustments

Pattern: ^-?\d{0,8}(?:\.\d{0,2})?$
​
available_tenures
object[]
required

Available tenure durations for this insurance product with their prices

​
additional_metadata
any | null

Additional information about the quote