Skip to main content
POST
/
api
/
v1
/
policies
/
cancel
curl --request POST \
  --url https://dev.superpool.unyte.africa/api/v1/policies/cancel \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "policy_id": "d5c36562-b86f-4e97-8288-8c6cb2da35ef",
  "policy_number": "INS-2023-00001",
  "cancellation_reason": "No longer interested in the policy"
}
'

Authorizations

​
X-API-Key
string
header
required

Query Parameters

​
policy_id
string

Unique ID of the policy

​
policy_number
string

policy reference number assigned by the insurer

Body

Validates a policy cancellation request

​
cancellation_reason
string
required
Maximum string length: 500
​
policy_id
string<uuid>
​
policy_number
string
Maximum string length: 255
​
alternative_offerings
any

Optional: Information on alternative policies or offers that might suit the policyholder needs, provided by the merchant before proceeding with cancellation

​
merchant_feedback
string

Optional: Feedback or comments from the merchant on the policyholder's request for cancellation

Maximum string length: 500

Response

Policy cancellation successful