For the complete documentation index, see llms.txt. This page is also available as Markdown.

Create a new Claim

Create a new Claim async

POST https://api.xclaim.xcover-staging.com/api/v2/partners/{partnerCode}/claims

Create a new claim by partner user via the async request, which will create the claim after the request has completed validation and returned a response.

If you can not use the async version, please see below for standard Create a new Claim section.

Please make sure you understand the new claim workflow (described in the Claim Creation Workflow).

Path Parameters

Name
Type
Description

partnerCode*

String

eg. XYZ999

{
  "claimTypeId": "ebc6af28-f2bb-4c10-a6db-1e821067453c",
  "bookingReference": "JPJMU-KUXRX-INS",
  "quoteReference": "034327ff-3687-4baf-ab25-68c5bdd24c60",
  "language": "en",
  "webhooks": [
    {
      "url": "https://webhook.site/1d92366e-7971-41b6-a2e4-3c90092e51a3",
    }
  ],
  "sectionFields": {
    "claimant_section:first_name": {
      "value": "John"
    },
    "claimant_section:middle_name": {
      "value": null
    },
    "claimant_section:last_name": {
      "value": "Doe"
    },
    "claimant_section:email": {
      "value": "[email protected]"
    },
    "claimant_section:phone": {
      "value": null
    },
    "claimant_section:date_of_birth": {
      "value": null
    },
    "claimant_section:address1": {
      "value": "!009 Example Street"
    },
    "claimant_section:address2": {
      "value": null
    },
    "claimant_section:city": {
      "value": "Sydney"
    },
    "claimant_section:state_province": {
      "value": "NSW"
    },
    "claimant_section:postal_code": {
      "value": "2000"
    },
    "claimant_section:country": {
      "value": "AU"
    },
    "claim_information:description": {
      "value": "JPJMU-KUXRX-INS"
    },
    "claim_information:loss_at": {
      "value": "2023-07-01 03:08:36"
    },
    "claim_details:vehicle_registration": {
      "value": null
    },
    "claim_details:vehicle_registration_plate": {
      "value": null
    },
    "claim_details:driver_id": {
      "value": null
    },
    "claim_details:imei": {
      "value": null
    },
    "claim_details:color": {
      "value": null
    },
    "claim_details:shade": {
      "value": null
    },
    "claim_details:num_enum": {
      "value": null
    },
    "claim_details:declared_value": {
      "value": 0
    },
    "claim_details:pickup_date": {
      "name": "pickup_date",
      "value": null
    }
  }
}

Create a new Claim

POST https://staging.api.xclaim.xcover.com/partners/{partnerCode}/claims

Create a new claim by partner user. Please make sure you understand the new claim workflow (described in the Claim Creation Workflow).

Path Parameters

Name
Type
Description

partnerCode*

String

eg. XYZ999

Headers

Name
Type
Description

Authorization*

String

Bearer {{JWT token}}

Last updated

Was this helpful?