Offer
Offer object
Name | Type | Description |
---|---|---|
id | string | The unique identifier of the offer. |
version_id | string | The version identifier of the offer. |
distributor_id | string | The ID of the distributor associated with the offer. |
insurer_id | string | The ID of the insurer associated with the offer. |
item_id | string | The ID of the item related to the offer. |
product_version_id | string | The version ID of the product associated with the offer. |
touchpoint_id | string | The ID of the touchpoint associated with the offer. |
product_id | string | The ID of the product linked to the offer. |
integration_version_id | string | The ID of the integration version associated with the offer. |
subscription_plan_id | string | The ID of the subscription plan related to the offer. |
insurer_policy_id | string | The assigned insurer's policy ID. |
first_name | string | The first name of the customer associated with the offer. |
last_name | string | The last name of the customer associated with the offer. |
string | The email address of the customer associated with the offer. | |
currency | string | The currency used for the offer. |
language | string | The language used for communication related to the offer. |
flow | string | The flow or process used for handling the offer. |
status | string | The status of the offer (e.g., accepted, pending, etc.). |
quote | object | An object containing detailed information about the quote related to the offer. |
data | object | An object containing additional data related to the offer (e.g., company details). |
media | array | An array of media files or assets associated with the offer. |
metadata | object | An object containing additional metadata about the offer. |
cancellation_reason | string | The reason for cancellation, if applicable. |
cancelled_by | string | The entity that cancelled the offer, if applicable. |
cancelled_at | string | The timestamp when the offer was cancelled, if applicable. |
distributor_traffic_source | string | The traffic source of the distributor, if applicable. |
referrer_url | string | The referring URL, if applicable. |
payment_token | string | The payment token, if applicable. |
whitelisted_referrer_url | string | A whitelisted referring URL, if applicable. |
linked_id | string | The ID of a linked offer, if applicable. |
customer_id | string | The ID of the customer associated with the offer. |
accepted_at | string | The timestamp when the offer was accepted. |
created_at | string | The timestamp when the offer was created. |
assets | array | An array of asset files associated with the offer. |
contains_sensitive_data | boolean | Indicates whether the offer contains sensitive data. |
is_version_assembled | boolean | Indicates whether the version of the offer is assembled. |
_links | object | An object containing various links related to the offer. |
Create an offer
Create an offer
POST
https://api.eu1.kaskocloud.com/policies
Query Parameters
Name | Type | Description |
---|---|---|
key | String | Public key |
Headers
Name | Type | Description |
---|---|---|
Accept* | String | application/vnd.kasko.v2+json |
Authorization | String | Bearer: <Secret-key> |
Request Body
Name | Type | Description |
---|---|---|
first_name* | String | First name of the customer |
last_name* | String | Last name of the customer |
email* | String | Email address of the customer |
language* | String | Language code |
data* | JSON | Product specific data |
sensitive_data | JSON | Sensitive policy data that will be encrypted at rest. |
quote_token* | String | Quote token |
metadata | JSON | An object containing additional metadata about the offer |
media | Array | An array of media files or assets associated with the offer |
distributor_traffic_source | String | The traffic source of the distributor |
referrer_url | String | Referrer URL |
sales_lead_id | String | Sales lead ID associated with the offer |
View offer
View offer
GET
https://api.eu1.kaskocloud.com/offers/{offerId}
Path Parameters
Name | Type | Description |
---|---|---|
offerId* | String | Offer ID |
Headers
Name | Type | Description |
---|---|---|
Authorization* | String | Bearer: <Secret-key> |
Last updated