curl --request POST \
--url https://dev.superpool.unyte.africa/api/v1/policies/renew/ \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"policy_id": "ba4fc272-5591-4812-9f36-48c3ffb27a69",
"preferred_policy_start_date": "2025-02-02",
"policy_duration": 180
}
'{
"renewal_status": "success",
"message": "Policy Renewal successful",
"data": {
"policy_number": "POL-2021-01-0001",
"policy_duration": 365,
"policy_metadata": {
"product_name": "Basic Health Coverage",
"product_type": "Health",
"insurer": "Reliance Health",
"customer_name": "Janet Joestar",
"customer_email": "janet.joe@email.com",
"customer_phone": "+234 123 456 7890",
"customer_address": "123, Main Street, Lagos, Nigeria",
"policy_status": "active",
"policy_id": "e2f7ca44-905a-4e22-b31f-2d1f23fb1c07",
"renewable": true
},
"renewal_date": "2024-11-01"
}
}Policies
Renew a policy
This action allows you as a merchant to submit a renewal request for your customer
POST
/
api
/
v1
/
policies
/
renew
/
curl --request POST \
--url https://dev.superpool.unyte.africa/api/v1/policies/renew/ \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"policy_id": "ba4fc272-5591-4812-9f36-48c3ffb27a69",
"preferred_policy_start_date": "2025-02-02",
"policy_duration": 180
}
'{
"renewal_status": "success",
"message": "Policy Renewal successful",
"data": {
"policy_number": "POL-2021-01-0001",
"policy_duration": 365,
"policy_metadata": {
"product_name": "Basic Health Coverage",
"product_type": "Health",
"insurer": "Reliance Health",
"customer_name": "Janet Joestar",
"customer_email": "janet.joe@email.com",
"customer_phone": "+234 123 456 7890",
"customer_address": "123, Main Street, Lagos, Nigeria",
"policy_status": "active",
"policy_id": "e2f7ca44-905a-4e22-b31f-2d1f23fb1c07",
"renewable": true
},
"renewal_date": "2024-11-01"
}
}Authorizations
Body
application/jsonapplication/x-www-form-urlencodedmultipart/form-data
Validates a policy renewal request
Response
Insurance Policy Renewal successful
Formats response information for insurance renewal request
Formats response information for insurance renewal request
Its a limited view of the PolicySerializer - exposing just enough informtion
Show child attributes
Show child attributes
Unique identifier for the policy
Policy Refrence Number assigned by the insurer e.g GI86585700-1, AXA2024727-2, LEAD18002-42, etc
⌘I