The claim object

The Claim object represents an issue reported against a contract. It includes information about the claim’s status, associated entities, and processing details.

JSON

{
  "object": "claim",
  "id": "a847b248-b946-45bd-b0d0-339ce9e5ab48",
  "store_id": "a8f7d740-f638-4c05-89b1-ff24ea9c85dc",
  "physical_store_id": null,
  "contract_id": "c35f12c4-2c49-4d5b-bb68-5acb97877066",
  "customer_contract_id": "ABCDRZXY",
  "incident": {
    "description": "My product is broken after it fell from a table.",
    "incident_date": "2024-03-02",
    "reported_cause": "accidental_damage"
  },
  "customer_provided_incident_date": null,
  "status": "approved",
  "submitted_at": "2025-02-27T13:50:04Z",
  "approved_at": "2025-02-27T13:50:34.815616Z",
  "customer_provided_imei": null,
  "settled_at": null,
  "declined_at": null,
  "withdrawn_at": null,
  "investigated_cause": null,
  "resolution_type": null
}

Attributes

name	type	description
object	string	Fixed value "claim" - identifies the resource type.
id	string	Unique identifier of the claim.
store_id	string	ID of the store associated with the claim (present when applicable).
physical_store_id	string	Identifier of the physical store (if applicable), or null.
contract_id	string	ID of the contract linked to this claim (when applicable).
customer_contract_id	string	customer_contract_id of the contract linked to this claim.
incident	Incident object	Details about the incident that triggered the claim (see nested fields below).
description	string	Textual description of what happened.
incident_date	date	Date when the incident occurred.
reported_cause	enum: "breakdown", "accidental_damage", "stolen", "stolen_accessories", "lost", "burn", "tear", "stain", "measurement_error", "oxidation", "puncture", "installation_damage", "transport_damage", "physical_accident", "unpacking_damage", "cutting_error", "lost_accessories", "other"	Cause of incident as reported by the customer. New values may be added in the future; clients must ignore or safely handle unknown values.
customer_provided_incident_date	date	Date of the incident as provided by the customer (optional).
status	enum: "new", "in_review", "awaiting_documents", "awaiting_customer_payment", "approved", "settled", "declined", "withdrawn"	Current processing status of the claim.
submitted_at	timestamp	Date and time when the claim was submitted.
approved_at	timestamp	Date and time when the claim was approved (if approved).
customer_provided_imei	string	IMEI provided by the customer (if relevant/applicable).
settled_at	timestamp	Date and time when the claim was settled (if settled).
declined_at	timestamp	Date and time when the claim was declined (if declined).
withdrawn_at	timestamp	Date and time when the claim was withdrawn (if withdrawn).
investigated_cause	string	Cause of the incident as determined after investigation (if available).
resolution_type	string	Final resolution type applied to the claim (if resolved).