Skip to main content
GET
View all claims made by your customers

Authorizations

X-API-Key
string
header
required

Path Parameters

id
string
required

UUID of the claim

Query Parameters

claim_type
string

Filter claims by product category

customer_email
string<email>
first_name
string
insurer
string

Filter claims by insurer

last_name
string
phone_number
string

Response

200 - application/json

List of claims

claim_id
string<uuid>
required
read-only
claim_reference_number
string
required
claim_status
string
required
claim_date
string<date>
required
read-only
claimant
string
required
read-only
claim_type
string | null
required
read-only
claim_amount
string<decimal>
required
Pattern: ^-?\d{0,8}(?:\.\d{0,2})?$
amount_payable
string<decimal> | null
required
Pattern: ^-?\d{0,8}(?:\.\d{0,2})?$
insurer
string
required
product
object
required

Serilizes the metadata about the product category a claim belongs to

policy
string<uuid>
required

Unique identifier for the policy

notes
string | null
required
read-only
documents
string
required
read-only
claim_status_timeline
object[]
required
read-only
incident_date
string<date> | null
incident_description
string | null
estimated_loss
string<decimal> | null
Pattern: ^-?\d{0,8}(?:\.\d{0,2})?$