Policy
Policy object
Name | Type | Description |
---|---|---|
id | string | The unique identifier of the policy. |
version_id | string | The version identifier of the policy. |
distributor_id | string | The ID of the distributor associated with the policy. |
touchpoint_id | string | The ID of the touchpoint associated with the policy. |
item_id | string | The ID of the item related to the policy. |
product_id | string | The ID of the product linked to the policy. |
product_version_id | string | The version ID of the product associated with the policy. |
integration_version_id | string | The ID of the integration version associated with the policy. |
insurer_policy_id | string | The insurer's assigned policy ID. |
distributor_key | string | The key or token for the distributor. |
insurer_external_policy_id | string | The external policy ID from the insurer, if applicable. |
first_name | string | The first name of the customer associated with the policy. |
last_name | string | The last name of the customer associated with the policy. |
expired | boolean | Indicates whether the policy has expired (false) or not (true). |
string | The email address of the customer associated with the policy. | |
currency | string | The currency used for the policy. |
policy_created_date | string | The timestamp when the policy was created. |
start_date | string | The start date of the policy coverage. |
end_date | string | The end date of the policy coverage, if applicable. |
termination_date | string | The termination date of the policy, if applicable. |
language | string | The language used for communication related to the policy. |
status | string | The status of the policy (e.g., "paid", "pending", etc.). |
data | object | An object containing additional data related to the policy (e.g., company details). |
quote | object | An object containing detailed information about the quote related to the policy. |
metadata | object | An object containing additional metadata about the policy. |
cancellation_reason | string | The reason for cancellation, if applicable. |
cancelled_by | string | The entity that cancelled the policy, if applicable. |
cancelled_at | string | The timestamp when the policy was cancelled, if applicable. |
referrer_url | string | The referring URL, if applicable. |
assets | array | An array of asset files associated with the policy. |
media | array | An array of media files associated with the policy. |
is_locked | boolean | Indicates whether the policy is locked (true) or not (false). |
localized_dates | object | An object containing localized dates for different fields. |
contains_sensitive_data | boolean | Indicates whether the policy contains sensitive data (true) or not (false). |
sales_lead_id | string | The ID of the sales lead associated with the policy, if applicable. |
_links | object | An object containing various links related to the policy (e.g., self-link, distributor link, etc.). |
Depending on the requester permissions, some fields of the policy object are restricted.
View policy
View Policy
GET
https://api.eu1.kaskocloud.com/policies/{policyId}
Path Parameters
Name | Type | Description |
---|---|---|
policyId* | String | Policy ID |
Headers
Name | Type | Description |
---|---|---|
Authorization | String | Bearer: <Secret-key> |
Cancel policy
Cancel Policy
POST
https://api.eu1.kaskocloud.com/policies/{policyId}/cancel
Headers
Name | Type | Description |
---|---|---|
Authorization* | String | Bearer: <Secret-key> |
If-Match* | String | Policy version ID |
Request Body
Name | Type | Description |
---|---|---|
cancellation_reason* | String | Cancellation reason |
termination_date* | String | Termination date in ISO format |
This response is returned in case the specified policy cannot be found in the system.
Last updated