Usecases
Divided into four customer-focused key functionalities, our APIs allows for:- Claim Submission: Allows merchants to file new claims on behalf of their customers, providing comprehensive incident details and supporting evidence.
- Claim Information Updates: Empowers merchants to modify claim information prior to adjudication, ensuring accuracy and completeness.
- Claim Retrieval: Enables merchants to retrieve specific claim details using claim IDs or claim numbers.
- Claim Tracking: Provides merchants with a comprehensive view of all customer-submitted claims, allowing for real-time tracking and insightful reporting.
Flow Diagram
Claims Initiation & Filing
This endpoint faciliate the initial of the filing process. A customer experiences an incident covered by their purchased policy. Merchant utlizes this API to initiate the claim, providing all required and supporting evidences. Request Fields| 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) |
Information Update
This API empowers the merchant to modify specific aspect of the claim details before adjudication. In accordance with our partner providers, some information are non-changeable after initial request, so please confirm details before successfuly filing a claim request on behalf of your customer claim request. Request Fields| 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) |
Claims Tracking
Our platform provides two APIs for tracking claims information across customers. These are:View Claim Information
This endpoint allows merchants to retrieve detailed information about a specific claim using either the claim ID or the claim number. Endpoint:GET /claims/{claimId}
Path Parameters:
claimId(string, UUID): The unique identifier of the claim.
View All Claims
This endpoint allows merchants to retrieve a list of all claims associated with their account. Merchants can filter and paginate the results to manage large datasets effectively. Endpoint: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.