Claim

Properties

Properties
claim_id string Must be a UUID. The unique identifier of the claim.
claim_number string A human-readable claim reference number.
created_at string The timestamp at which the claim was opened.
updated_at string The timestamp at which the claim was last updated.
policy_id string,null Must be a UUID. The identifier of the policy attached to this claim. May be `null` if no policy is linked yet.
policyholder_id string,null Must be a UUID. The identifier of the policyholder for this claim. May be `null` if no policyholder is linked yet.
member_id string,null Must be a UUID. The identifier of the member for this claim. Only used for group scheme policies. May be `null`.
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.
claim_status string The current status of the claim.
approval_status string The approval decision status of the claim.
claimant object,null An object containing the claimant's details. `null` if no claimant is specified.
incident_type string,null A description of the incident type.
incident_cause string,null A description of the cause of the incident.
incident_date string,null The date on which the incident occurred.
assigned_to string,null Must be a UUID. The identifier of the user to whom this claim is assigned.
app_data object,null An object containing additional custom data for the claim.
module_data object,null An object containing data populated by the product module.
requested_amount integer,null The requested payout amount (in cents) for the claim.
granted_amount integer,null The granted payout amount (in cents) for the claim.
rejection_reason string,null The reason for claim rejection, if applicable.
currency string The currency code for monetary amounts (e.g., `ZAR`, `USD`).
created_by object,null An object indicating the user or API key that created the claim. See Authentication.
policyholder object,null The policyholder object. Only included when `include=policyholder` query parameter is specified.
policy object,null The policy object. Only included when `include=policy` query parameter is specified.
member object,null The member object for group scheme policies. Only included when available.
user_group object,null The user group object. Only included when `include=user_group` query parameter is specified.
block_states object,null An object containing the current state of claim blocks (dynamic form fields).

Example

{
  "claim_id": "d3d13c48-4dc3-4816-8d01-de3215878225",
  "claim_number": "D33B754ADA8F",
  "created_at": "2017-10-16T10:12:02.872Z",
  "updated_at": "2017-10-16T10:15:02.872Z",
  "policy_id": "8349345c-a6c5-4bf9-8ebb-6bbfc1628715",
  "policyholder_id": "00000000-0000-0000-0000-000000000004",
  "member_id": "673b8081-9668-4136-97cc-6ae0debda083",
  "covered_item_id": "9dc39b57-cdc7-48f9-a303-d7c4f0421a0c",
  "claim_status": "open",
  "approval_status": "pending",
  "claimant": {
    "first_name": "Erlich",
    "last_name": "Aviato",
    "email": "[email protected]",
    "cellphone": "0821234567",
    "relationship": "main_member"
  },
  "incident_type": "Theft",
  "incident_cause": "Device stolen during burglary",
  "incident_date": "2017-10-15T08:00:00.000Z",
  "app_data": {
    "key1": "value 1",
    "key2": "value 2"
  },
  "requested_amount": 13000000,
  "granted_amount": null,
  "currency": "ZAR",
  "created_by": {
    "id": "00000000-0000-0000-0000-000000000001",
    "type": "user"
  }
}