Claim Object

Claim objects represent the top-level "container" for all claim-related records, some of which are stored as attributes on the Claim object itself and others are stored in nested objects.

Attribute	Data Type	Description
id	Integer	The unique ID for the claim given by Claimable.
title	String	The title of the claim. If blank, the claimant name will be used.

{
  "id": 1,
  "title": "David Smith",
  "type": "property",
  "labels": [
    "awaiting-repairs",
    "approved"
  ],
  "incident_type": "theft",
  "sub_incident_type": "break_in",
  "claimant": {
    "first_name": "John",
    "last_name": "Smith",
    "email": "[email protected]",
    "id": 1,
    "match_existing": true,
    "role": "main_contact"
  },
  "insured": {
    "first_name": "John",
    "last_name": "Smith",
    "email": "[email protected]",
    "id": 1,
    "match_existing": true,
    "role": "main_contact"
  },
  "reported_at": "2020-12-13T09:45:12Z",
  "incident_occurred_at": "2020-12-12T16:32:34Z",
  "status": "open",
  "status_changed_by": 1234,
  "opened_at": "2023-05-11T14:55:58.934Z",
  "closed_at": null,
  "claim_duration": 84,
  "incident_description": "Break in via kitchen windown and stolen TV.",
  "claim_ref": "ABC123",
  "external_claim_ref": "XYZ789",
  "incident_location_address_line1": "1 Mentmore Terrace",
  "incident_location_address_line2": "",
  "incident_location_address_line3": "",
  "incident_location_address_city": "London",
  "incident_location_address_state": "London",
  "incident_location_address_postcode": "E8 3PN",
  "incident_location_address_country": "United Kingdom",
  "incident_location_address_country_code": "gbr",
  "incident_location_description": "Lower ground floor kitchen.",
  "policy_no": "XXX-111-222",
  "estimated_claim_cost": 100000,
  "actual_claim_cost": 100000,
  "settled_amount": 100000,
  "reserve_amount": 100000,
  "excess_amount": 100000,
  "total_reserve": 200000,
  "total_paid": 100000,
  "outstanding_reserve": 100000,
  "last_activity_at": "2023-06-09T14:54:32.575Z",
  "last_activity_key": "claim.note.create",
  "last_activity_description": "Created note",
  "last_activity_by": 9,
  "conversations_count": 55,
  "open_conversations_count": 2,
  "closed_conversations_count": 48,
  "tasks_count": 44,
  "outstanding_tasks_count": 13,
  "completed_tasks_count": 31,
  "assigned_to": 1234,
  "assigned_at": "2023-06-08T13:51:12.575Z",
  "client": 111,
  "broker": 222,
  "insurer": 333
}

The `ClaimParty` Object

The ClaimParty object defines a contact or company who can be either or both claimant and insured on a claim.

Attribute	Data Type	Description
id	Integer	The Claimable contact ID if linking an existing contact. \n \nIf present, `match_existing` is always true.
first_name	String	Required - unless `is_business` is true. \n \nThe first name of the contact to create or link. If `is_business` is true, this becomes the first name of the primary contact person for that business.
last_name	String	Required - unless `is_business` is true. \n \nThe last name of the contact to create or link. If `is_business` is true, this becomes the last name of the primary contact person for that business.
business_name	String	Required - if `is_business` is true. \n \nThe name of the business to create or link if `is_business` is true, indicating the contact is refers to a business entity rather than an individual. \n \nIf `is_business` is false, the `business_name` refers to the business to which the individual is related to.
is_business	Boolean	Default: false \n \nIndicates if the contact to create or link refers to an individual (false) or business (true).
email	String	The email of the contact to create or link.
match_existing	Boolean	Default: true \n \nIf true, use the existing contact if an existing record can be found (exact match). Otherwise, create new.
role	String	Claimable slug for the contact role.
liability	String	Claimable slug for the contact liability.

Claim Object

Example Claim Object

The ClaimParty Object

The `ClaimParty` Object