Describes endpoints related to filing and tracking claims
Field | Type | Required | Description |
---|---|---|---|
claimant_metadata | object | Yes | Metadata about the claimant (first name, last name, birth date, email, phone number, relationship) |
claim_details | object | Yes | Important Details of the claim (such as claim type, incident description, incident date, claim amount, supporting documents) |
policy_id | uuid | No | Unique identifier of the insurance policy |
policy_number | string | No | Insurance Policy Number as assigned by the provider |
witness_details | list | No | Information about witnesses present at the time of the incident |
authority_report | object | No | Details of any authority report (such as police report, medical report, drug report, etc) |
Field | Type | Required | Description |
---|---|---|---|
claimant_metadata | object | ~ | Updates can only happen on specific metadata about the claimant (such as the claimant’s email, age, phone number, etc) |
claim_details | object | ~ | Details of the claim (such as incident date and incident description) |
witness_details | list | ~ | Details of witnesses (full name, contact phone, contact email, statement) |
GET /claims/{claimId}
Path Parameters:
claimId
(string, UUID): The unique identifier of the claim.GET /claims
Query Parameters:
customer_email
(email, optional): Filter claims by the customer’s email address.first_name
(string, optional): Filter claims by the customer’s first name.last_name
(string, optional): Filter claims by the customer’s last name.phone_number
(string, optional): Filter claims by the customer’s phone number.limit
(integer, optional): Number of results to return per page. Defaults to a platform defined limit.offset
(integer, optional): The initial index from which to return the results. Defaults to 0.