Insurance
The Insurance resource encompasses the details of an insurance policy associated with a contact. It includes information such as the insurer, policy type, policy number, claim intend, coverage type, deductible, excess, onward travel coverage, and additional notes.
Events
The following events are available for insurance:
| Event Type | Description |
|---|---|
insurance.created | Triggered when new insurance information is added to a contact |
insurance.updated | Triggered when any insurance information is modified |
insurance.deleted | Triggered when insurance information is removed from a contact |
The insurance object
Attributes
- objectstring
Type of the insurance, marked as "Insurance" for conventional motor policies.
- idstring
Unique identifier for the insurance.
- insurerstring or null
Name of the insurance company.
- policy_typestring or null
Type of insurance policy.
- policy_numberstring or null
Policy number.
- claim_intendboolean or null
Marker for when a contact has consented to make a claim through the insurer. Useful where client for accident assistance and insurance is the same, to identify insurance sourced customers.
- valid_fromstring or null
Start date of the insurance policy.
- valid_tostring or null
End date of the insurance policy.
- coverage_typestring or null
Type of coverage provided by the insurance.
- vehicle_involved_coveredboolean
Indicates whether the insurance covers vehicle involvement.
- policy_contact_is_driverboolean
Indicates whether the contact is the driver covered by the policy.
- insurance_limits_notestring or null
Additional notes on insurance limits.
- deductible_excess_compulsorystring or null
Deductible or excess for compulsory coverage.
- deductible_excess_voluntarystring or null
Deductible or excess for voluntary coverage.
- deductible_excess_totalstring or null
Total deductible or excess amount.
- deductible_excess_cover_addonstring or null
Deductible or excess for additional coverage.
- deductible_excess_notestring or null
Additional notes on deductible or excess.
- onward_travel_coverstring or null
Onward travel coverage.
- onward_travel_cover_notestring or null
Additional notes on onward travel coverage.
- insurance_notestring or null
Additional notes on the insurance.
- created_atDate
Date when the insurance was created.
- updated_atDate
Date when the insurance was last updated.
interface Insurance {
object: "Insurance";
id: string;
insurer: string | null;
policy_type: string | null;
policy_number: string | null;
claim_intend: boolean | null
valid_from: string | null;
valid_to: string | null;
coverage_type: string | null;
vehicle_involved_covered: boolean;
policy_contact_is_driver: boolean;
insurance_limits_note: string | null;
deductible_excess_compulsory: string | null;
deductible_excess_voluntary: string | null;
deductible_excess_total: string | null;
deductible_excess_cover_addon: string | null;
deductible_excess_note: string | null;
onward_travel_cover: string | null;
onward_travel_cover_note: string | null;
insurance_note: string | null;
created_at: string;
updated_at: string;
}