> ## Documentation Index
> Fetch the complete documentation index at: https://docs.unyte.africa/llms.txt
> Use this file to discover all available pages before exploring further.
# Definitions
## activation\_metadata
Metadata regarding policy activation conditions.
```json theme={null}
{
"renew": false,
"send_customer_notification": true,
}
```
| | |
| ---------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| renew | boolean
If true, indicates that this insurance policy should automatically renew at the end of each default year. The renewal duration is set to the selected tenure at the time of purchase, hence, for a Two-year policy at purchase, at the end of the first two years, the system automatically renews it for another two year duration. |
| send\_customer\_notification | boolean
Indicates if we should notify the customer of the policy purchase request. This gives merchants' control over notification policy, should they decide to send the customer a notification from their end. We however, only send information regarding a successful purchase, such as `transactionId`, the customer information along with timestamps of purchase. Think of it as a receipt. |
## additional\_information
As with Quotes, data are captured differently according to the insurance `product_type`. Below are list of definitions with an example for
each of them.
### Auto Insurance
| | |
| -------------------- | -------------------------------------------------------------------------------------------------------------------- |
| make | string `=100 characters`
Represents the vehicle brand. |
| model | string `=100 characters`
Represents the vehicle model. |
| owner | string
Full-name of the vehicle owner, as registered with the government. |
| value | decimal `>= 2,000,000`
Market-value of the vehicle. |
| year | date
Year of vehicle registration. |
| usecase | string `enum: [`private`, `commercial`]`
Indicates if vehicle is used for `private` or `commercial` purposes. |
| vehicle\_type | string
Category of the vehicle (e.g `saloon`, `SUV`, `light_truck`, `heavy_truck`, `heavy_duty_truck`). |
| chassis\_number | string
Unique-identifier of the chassis plate as provided by the manufacturer. |
| engine\_number | string
Unique engine identifier. |
| registration\_number | string
Official license plate registration number. |
```json theme={null}
{
"make": "Toyota",
"model": "Camry",
"value": 2500000,
"owner": "John Doe",
"year": "2020-01-01",
"usecase": "private",
"vehicle_type": "SUV",
"engine_number": "ENG123456789",
"chassis_number": "CHS987654321",
"registration_number": "ABC123XYZ"
}
```
### Device Insurance
| | |
| -------------- | ------------------------------------------------------------------------------------- |
| make | string
Device manufacturer brand e.g Apple, HP or Samsung. |
| model | string
Specific-model (e.g S25, or iPhoneX). |
| value | string
Market-value of the device insured. |
| serial\_number | string
Device serial number as assigned by the manufacturer. |
| imei | string
International Mobile Equipment Identity (mandatory for mobile devices). |
| device\_type | string
Category of the device in question (e.g `pos`, `phone`, `tablet`, etc). |
```json theme={null}
{
"make": "Apple",
"model": "iPhone 15 Pro",
"value": "1600000",
"serial_number": "SN1234567890",
"imei": "IMEI0987654321",
"device_type": "phone"
}
```
### Personal Accident Insurance
| | |
| ------------------------- | ------------------------------------------------------------------------------------------------------- |
| occupation | string
The applicant's occupation. |
| risk\_level | string `enum: [`Low`, `Medium`, `High`]`
Risk category based on occupation. |
| occupation\_risk\_details | string `enum: [`office`, `field`, `remote`]`
Additional details regarding the occupational risk. |
```json theme={null}
{
"occupation": "Construction Worker",
"risk_level": "High",
"occupation_risk_details": "field"
}
```
### Home Insurance
| | |
| ------------------------ | ----------------------------------------------------------------------------- |
| property\_value | decimal
Estimated market-value of property. |
| stationary\_items\_value | decimal
Estimated value of immovable items. |
| mobile\_items\_value | decimal
Estimated value of movable items. |
| location | string
Location (Format: `State, Country`). |
| fire\_protection | boolean
Indicates if fire safety measures are installed. |
| security\_details | object
Additional security information (e.g alarm systems, cctv, etc). |
### Shipment (Cargo) Insurance
| | |
| ----------------- | ----------------------------------------------------------------------------------------- |
| originating\_port | string
Port where the shipment originated. |
| destination\_port | string
Destination port of the shipment. |
| currency | string
Currency used for the transaction (e.g `USD`, `NGN`, `EUR`). |
| bank\_name | string
Name of the bank facilitating the transaction. |
| invoice\_number | string
Unique invoice number for the shipment. |
| cac\_number | string
Corporate Affairs Commission registration number of the responsible entity. |
| tin\_number | string
Tax Identification Number. |
| lc\_number | string
Letter of Credit number associated with transaction. |
| cargo | string
Detailed description of cargo or shipment. |
```json theme={null}
{
"originating_port": "Lagos Port",
"destination_port": "Apapa Port",
"currency": "NGN",
"bank_name": "First Bank",
"invoice_number": "INV-123456",
"cac_number": "CAC987654",
"tin_number": "TIN123456",
"lc_number": "LC654321",
"cargo": "Electronics shipment including laptops and smartphones."
}
```