Create a claim

post

https://sandbox.uk.rootplatform.com/v1/insurance/claims

Creates a new claim. The claim can optionally be linked to a policy, member, or covered item. A claimant can be specified with contact details.

Query Params

include

array of strings

A comma-separated list of related objects to include in the response. Valid values: policy, policyholder, user_group.

include

Body Params

policy_id

string | null

Must be a UUID. The identifier of the policy on which the claim is being made.

member_id

string | null

Must be a UUID. The identifier of the member for this claim. Only used for group scheme policies.

covered_item_id

string | null

Must be a UUID. The identifier of the covered item that this claim is against. Required if the policy supports covered items.

assigned_to_user_id

string | null

Must be a UUID. The identifier of the user to assign this claim to.

incident_type

string | null

A description of the incident type.

incident_cause

string | null

A description of the cause of the incident.

incident_date

date-time | null

The date on which the incident occurred.

app_data

object | null

An object containing additional custom data for the claim.

claimant

object

Object containing claimant's details. At least one of email or cellphone must be provided.

requested_amount

integer

The requested payout amount (in cents) for the claim.

Response

Language

Credentials

Basic

base64

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success