Skip to main content
POST

Authorizations

X-API-Key
string
header
required

Headers

U-Request-Id
string

Idempotency key to enforce idempotent processing of POST requests

Body

Improved data handler for policy purchase requests

intent_id
string
required

Intent ID

merchant_code
string
required

Merchant or Partner Seller short code

Maximum string length: 50
additional_information
any
required

Insurance Product-specific additional information required for the selected product type e.g {"vehicle_make": "Toyota", "vehicle_model": "Camry"}

activation_metadata
object
required

Response

Policy purchase successful

Limited view of the PolicySerializer for the purchase response

effective_from
string<date>
required

Date the policy becomes active - determined by the time of purchase

effective_through
string<date>
required

Date the policy expires

premium
string<decimal>
required

Amount paid for the policy

Pattern: ^-?\d{0,8}(?:\.\d{0,2})?$
insurer
string
required
policy_status
string
required
product_information
object
required
read-only

Returns the product information as a dictionary

customer_information
object
required
read-only

Returns the customer information as a dictionary

renewal_information
object
required
read-only

Returns the renewal information as a dictionary

policy_id
string<uuid>

Unique identifier for the policy

policy_reference_number
string
default:""

Policy number issued to the customer as assigned by the insurer e.g GI86585700-1