We are currently in beta. If you have any feedback, please email us at tech@unyte.africa or learn more about our product at https://unyte.africa
curl --request GET \
--url https://dev.superpool.unyte.africa/api/v1/policies/{policy_id}/ \
--header 'X-API-Key: <api-key>'
{
"policy_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"policy_number": "<string>",
"effective_from": "2023-12-25",
"effective_through": "2023-12-25",
"premium": "<string>",
"policy_holder": {
"customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"customer_name": "<string>",
"customer_email": "jsmith@example.com",
"customer_phone": "<string>"
},
"merchant": "<string>",
"provider": {
"provider_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"provider_name": "<string>",
"email": "jsmith@example.com"
},
"coverage": "<string>",
"policy_type": "<string>",
"renewable": true,
"renewal_date": "2023-11-07T05:31:56Z",
"inspection_required": true,
"cerfication_required": true,
"status": "accepted",
"cancellation_initiator": "<string>",
"cancellation_reason": "<string>",
"cancellation_date": "2023-11-07T05:31:56Z",
"beneficiaries": [
{
"beneficiary_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"beneficiary_name": "<string>"
}
]
}
Retrieve a specific policy by its ID
curl --request GET \
--url https://dev.superpool.unyte.africa/api/v1/policies/{policy_id}/ \
--header 'X-API-Key: <api-key>'
{
"policy_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"policy_number": "<string>",
"effective_from": "2023-12-25",
"effective_through": "2023-12-25",
"premium": "<string>",
"policy_holder": {
"customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"customer_name": "<string>",
"customer_email": "jsmith@example.com",
"customer_phone": "<string>"
},
"merchant": "<string>",
"provider": {
"provider_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"provider_name": "<string>",
"email": "jsmith@example.com"
},
"coverage": "<string>",
"policy_type": "<string>",
"renewable": true,
"renewal_date": "2023-11-07T05:31:56Z",
"inspection_required": true,
"cerfication_required": true,
"status": "accepted",
"cancellation_initiator": "<string>",
"cancellation_reason": "<string>",
"cancellation_date": "2023-11-07T05:31:56Z",
"beneficiaries": [
{
"beneficiary_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"beneficiary_name": "<string>"
}
]
}
Unique identifier for the policy
Policy details
Serializer for the Policy model