Create a new Claim
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}}
{
"claimTypeId": "ebc6af28-f2bb-4c10-a6db-1e821067453c",
"bookingReference": "JPJMU-KUXRX-INS",
"quoteReference": "034327ff-3687-4baf-ab25-68c5bdd24c60",
"language": "en",
"sectionFields": [
{
"name": "claimant_section",
"fields": [
{
"name": "first_name",
"value": "John"
},
{
"name": "middle_name",
"value": null
},
{
"name": "last_name",
"value": "Doe"
},
{
"name": "email",
"value": "[email protected]"
},
{
"name": "phone",
"value": null
},
{
"name": "date_of_birth",
"value": null
},
{
"name": "address1",
"value": "!009 Example Street"
},
{
"name": "address2",
"value": null
},
{
"name": "city",
"value": "Sydney"
},
{
"name": "state_province",
"value": "NSW"
},
{
"name": "postal_code",
"value": "2000"
},
{
"name": "country",
"value": "AU"
}
]
},
{
"name": "claim_information",
"fields": [
{
"name": "description",
"value": "JPJMU-KUXRX-INS"
},
{
"name": "loss_at",
"value": "2023-07-01 03:08:36"
},
{
"name": "settlement_date",
"value": null
}
]
},
{
"name": "claim_details",
"fields": [
{
"name": "vehicle_registration",
"value": null
},
{
"name": "vehicle_registration_plate",
"value": null
},
{
"name": "driver_id",
"value": null
},
{
"name": "imei",
"value": null
},
{
"name": "color",
"value": null
},
{
"name": "shade",
"value": null
},
{
"name": "num_enum",
"value": null
},
{
"name": "declared_value",
"value": 0
},
{
"name": "pickup_date",
"value": null
}
]
}
]
}{
"data": {
"id": "9826cebc-75c8-4a21-8472-9dd72223a201",
"claimReference": "KGLNQ-LUUGY-CLA",
"bookingReference": "JPJMU-KUXRX-INS",
"status": {
"category": "Submitted"
},
"claimDetails": [
{
"id": "ccdf1af7-99ee-4984-9aad-5d88b64ad8b4",
"claimId": "9826cebc-75c8-4a21-8472-9dd72223a201",
"sectionFieldId": "96d4187c-bd99-45f5-b42f-146c4d00318f",
"value": "John",
"createdAt": "2023-08-07T01:26:13+00:00",
"updatedAt": "2023-08-07T01:26:13+00:00",
"sectionField": {
"id": "96d4187c-bd99-45f5-b42f-146c4d00318f",
"sectionId": "4ee53947-31d9-4129-86fc-9478cce3955a",
"fieldTypeId": "385b4ef5-9634-429f-9657-52133982377a",
"name": "first_name",
"required": false,
"readOnly": false,
"isInternal": false,
"validation": null,
"options": null,
"meta": {
"label": "First Name",
"tooltip": "Apple",
"isFieldSummaryRequired": false
},
"ordering": 0,
"createdAt": "2023-07-13T03:07:05+00:00",
"updatedAt": "2023-07-13T03:07:05+00:00",
"validations": null,
"translatables": {
"label": true,
"description": true,
"placeholder": true,
"content": false,
"tooltip": true
},
"useDefaultTranslation": true,
"conditions": null,
"isPii": false,
"conditionAndOr": null,
"type": "string",
"section": {
"id": "4ee53947-31d9-4129-86fc-9478cce3955a",
"name": "claimant_section",
"label": "Claimant Information",
"description": "Details about the claimant who wants to submit this claim",
"ordering": 0,
"createdAt": "2023-07-13T03:07:05+00:00",
"updatedAt": "2023-07-13T03:07:05+00:00"
}
}
},
{
"id": "2ac7d274-8161-4f1b-9d37-4af168dfdb52",
"claimId": "9826cebc-75c8-4a21-8472-9dd72223a201",
"sectionFieldId": "2daf60e3-cd8c-4b7b-806e-9ad561e8ef6f",
"value": "[email protected]",
"createdAt": "2023-08-07T01:26:13+00:00",
"updatedAt": "2023-08-07T01:26:13+00:00",
"sectionField": {
"id": "2daf60e3-cd8c-4b7b-806e-9ad561e8ef6f",
"sectionId": "4ee53947-31d9-4129-86fc-9478cce3955a",
"fieldTypeId": "385b4ef5-9634-429f-9657-52133982377a",
"name": "email",
"required": false,
"readOnly": false,
"isInternal": false,
"validation": null,
"options": null,
"meta": {
"label": "Email",
"description": "Email address",
"isFieldSummaryRequired": false
},
"ordering": 3,
"createdAt": "2023-07-13T03:07:05+00:00",
"updatedAt": "2023-07-13T03:07:05+00:00",
"validations": null,
"translatables": {
"label": true,
"description": true,
"placeholder": true,
"content": false,
"tooltip": true
},
"useDefaultTranslation": true,
"conditions": null,
"isPii": false,
"conditionAndOr": null,
"type": "string",
"section": {
"id": "4ee53947-31d9-4129-86fc-9478cce3955a",
"name": "claimant_section",
"label": "Claimant Information",
"description": "Details about the claimant who wants to submit this claim",
"ordering": 0,
"createdAt": "2023-07-13T03:07:05+00:00",
"updatedAt": "2023-07-13T03:07:05+00:00"
}
}
},
{
"id": "f16cacf5-0f2d-4452-b1b3-1e6c1cc0105b",
"claimId": "9826cebc-75c8-4a21-8472-9dd72223a201",
"sectionFieldId": "c13536e7-eba7-4ef1-b0f0-aae53bbee592",
"value": "Sydney",
"createdAt": "2023-08-07T01:26:13+00:00",
"updatedAt": "2023-08-07T01:26:13+00:00",
"sectionField": {
"id": "c13536e7-eba7-4ef1-b0f0-aae53bbee592",
"sectionId": "4ee53947-31d9-4129-86fc-9478cce3955a",
"fieldTypeId": "385b4ef5-9634-429f-9657-52133982377a",
"name": "city",
"required": false,
"readOnly": false,
"isInternal": false,
"validation": null,
"options": null,
"meta": {
"group": {
"name": "claimant_address",
"type": "address",
"role": "city"
},
"label": "City",
"isFieldSummaryRequired": false
},
"ordering": 8,
"createdAt": "2023-07-13T03:07:05+00:00",
"updatedAt": "2023-07-13T03:07:05+00:00",
"validations": null,
"translatables": {
"label": true,
"description": true,
"placeholder": true,
"content": false,
"tooltip": true
},
"useDefaultTranslation": true,
"conditions": null,
"isPii": false,
"conditionAndOr": null,
"type": "string",
"section": {
"id": "4ee53947-31d9-4129-86fc-9478cce3955a",
"name": "claimant_section",
"label": "Claimant Information",
"description": "Details about the claimant who wants to submit this claim",
"ordering": 0,
"createdAt": "2023-07-13T03:07:05+00:00",
"updatedAt": "2023-07-13T03:07:05+00:00"
}
}
},
{
"id": "f927191f-6c95-4f84-adcc-7266e38e33e3",
"claimId": "9826cebc-75c8-4a21-8472-9dd72223a201",
"sectionFieldId": "e793aecd-dd00-41ca-9a71-3f201163d249",
"value": "NSW",
"createdAt": "2023-08-07T01:26:13+00:00",
"updatedAt": "2023-08-07T01:26:13+00:00",
"sectionField": {
"id": "e793aecd-dd00-41ca-9a71-3f201163d249",
"sectionId": "4ee53947-31d9-4129-86fc-9478cce3955a",
"fieldTypeId": "385b4ef5-9634-429f-9657-52133982377a",
"name": "state_province",
"required": false,
"readOnly": false,
"isInternal": false,
"validation": null,
"options": null,
"meta": {
"group": {
"name": "claimant_address",
"type": "address",
"role": "state_province"
},
"label": "State / Province",
"isFieldSummaryRequired": false
},
"ordering": 9,
"createdAt": "2023-07-13T03:07:05+00:00",
"updatedAt": "2023-07-13T03:07:05+00:00",
"validations": null,
"translatables": {
"label": true,
"description": true,
"placeholder": true,
"content": false,
"tooltip": true
},
"useDefaultTranslation": true,
"conditions": null,
"isPii": false,
"conditionAndOr": null,
"type": "string",
"section": {
"id": "4ee53947-31d9-4129-86fc-9478cce3955a",
"name": "claimant_section",
"label": "Claimant Information",
"description": "Details about the claimant who wants to submit this claim",
"ordering": 0,
"createdAt": "2023-07-13T03:07:05+00:00",
"updatedAt": "2023-07-13T03:07:05+00:00"
}
}
},
{
"id": "102320f1-8d46-4939-b401-32c287899bb9",
"claimId": "9826cebc-75c8-4a21-8472-9dd72223a201",
"sectionFieldId": "ec2b29ef-530a-467b-a31d-3e4cab6bb387",
"value": "2000",
"createdAt": "2023-08-07T01:26:13+00:00",
"updatedAt": "2023-08-07T01:26:13+00:00",
"sectionField": {
"id": "ec2b29ef-530a-467b-a31d-3e4cab6bb387",
"sectionId": "4ee53947-31d9-4129-86fc-9478cce3955a",
"fieldTypeId": "385b4ef5-9634-429f-9657-52133982377a",
"name": "postal_code",
"required": false,
"readOnly": false,
"isInternal": false,
"validation": null,
"options": null,
"meta": {
"group": {
"name": "claimant_address",
"type": "address",
"role": "postal_code"
},
"label": "Postal Code",
"isFieldSummaryRequired": false
},
"ordering": 10,
"createdAt": "2023-07-13T03:07:05+00:00",
"updatedAt": "2023-07-13T03:07:05+00:00",
"validations": null,
"translatables": {
"label": true,
"description": true,
"placeholder": true,
"content": false,
"tooltip": true
},
"useDefaultTranslation": true,
"conditions": null,
"isPii": false,
"conditionAndOr": null,
"type": "string",
"section": {
"id": "4ee53947-31d9-4129-86fc-9478cce3955a",
"name": "claimant_section",
"label": "Claimant Information",
"description": "Details about the claimant who wants to submit this claim",
"ordering": 0,
"createdAt": "2023-07-13T03:07:05+00:00",
"updatedAt": "2023-07-13T03:07:05+00:00"
}
}
},
{
"id": "96e6711c-8bd0-4106-af9d-74cc3b93c5df",
"claimId": "9826cebc-75c8-4a21-8472-9dd72223a201",
"sectionFieldId": "4d364129-ef31-424c-91bc-d164d20f2da6",
"value": "AU",
"createdAt": "2023-08-07T01:26:13+00:00",
"updatedAt": "2023-08-07T01:26:13+00:00",
"sectionField": {
"id": "4d364129-ef31-424c-91bc-d164d20f2da6",
"sectionId": "4ee53947-31d9-4129-86fc-9478cce3955a",
"fieldTypeId": "2462deae-5286-4810-8a7b-e53de78e7e4b",
"name": "country",
"required": false,
"readOnly": false,
"isInternal": false,
"validation": null,
"options": null,
"meta": {
"group": {
"name": "claimant_address",
"type": "address",
"role": "country"
},
"label": "Country",
"description": "Claimant country",
"isFieldSummaryRequired": false
},
"ordering": 11,
"createdAt": "2023-07-13T03:07:05+00:00",
"updatedAt": "2023-07-13T03:07:05+00:00",
"validations": null,
"translatables": {
"label": true,
"description": true,
"placeholder": false,
"content": false,
"tooltip": true
},
"useDefaultTranslation": true,
"conditions": null,
"isPii": false,
"conditionAndOr": null,
"type": "country",
"section": {
"id": "4ee53947-31d9-4129-86fc-9478cce3955a",
"name": "claimant_section",
"label": "Claimant Information",
"description": "Details about the claimant who wants to submit this claim",
"ordering": 0,
"createdAt": "2023-07-13T03:07:05+00:00",
"updatedAt": "2023-07-13T03:07:05+00:00"
}
}
},
{
"id": "8dcadde7-1e87-4dfe-8f74-1695030e7dce",
"claimId": "9826cebc-75c8-4a21-8472-9dd72223a201",
"sectionFieldId": "5841a7c3-77ba-4d5a-bf9e-88d689adc709",
"value": "JPJMU-KUXRX-INS",
"createdAt": "2023-08-07T01:26:13+00:00",
"updatedAt": "2023-08-07T01:26:13+00:00",
"sectionField": {
"id": "5841a7c3-77ba-4d5a-bf9e-88d689adc709",
"sectionId": "7673c2b6-ca67-4571-b5f4-e1f1ad1cc5bf",
"fieldTypeId": "385b4ef5-9634-429f-9657-52133982377a",
"name": "description",
"required": false,
"readOnly": true,
"isInternal": false,
"validation": null,
"options": null,
"meta": {
"label": "Description",
"display": "large",
"description": "Long description of the claim",
"isFieldSummaryRequired": false
},
"ordering": 0,
"createdAt": "2023-07-13T03:07:05+00:00",
"updatedAt": "2023-07-13T03:07:05+00:00",
"validations": null,
"translatables": {
"label": true,
"description": true,
"placeholder": true,
"content": false,
"tooltip": true
},
"useDefaultTranslation": true,
"conditions": null,
"isPii": false,
"conditionAndOr": null,
"type": "string",
"section": {
"id": "7673c2b6-ca67-4571-b5f4-e1f1ad1cc5bf",
"name": "claim_information",
"label": "Claim Information",
"description": "Claim information section",
"ordering": 1,
"createdAt": "2023-07-13T03:07:05+00:00",
"updatedAt": "2023-07-13T03:07:05+00:00"
}
}
},
{
"id": "430c303c-39d1-4061-89c3-1b1deb5c4b4f",
"claimId": "9826cebc-75c8-4a21-8472-9dd72223a201",
"sectionFieldId": "c2e03fa0-6c68-4f69-8128-3ccf268ae3d8",
"value": "2023-07-01 03:08:36",
"createdAt": "2023-08-07T01:26:13+00:00",
"updatedAt": "2023-08-07T01:26:13+00:00",
"sectionField": {
"id": "c2e03fa0-6c68-4f69-8128-3ccf268ae3d8",
"sectionId": "7673c2b6-ca67-4571-b5f4-e1f1ad1cc5bf",
"fieldTypeId": "cd3cba2d-985f-4924-a26b-56abe629afba",
"name": "loss_at",
"required": true,
"readOnly": true,
"isInternal": false,
"validation": null,
"options": null,
"meta": {
"label": "When did the event happen",
"display": "date",
"description": "Date of the event",
"isFieldSummaryRequired": false
},
"ordering": 1,
"createdAt": "2023-07-13T03:07:05+00:00",
"updatedAt": "2023-07-13T03:07:05+00:00",
"validations": null,
"translatables": {
"label": true,
"description": true,
"placeholder": false,
"content": false,
"tooltip": true
},
"useDefaultTranslation": true,
"conditions": null,
"isPii": false,
"conditionAndOr": null,
"type": "datetime",
"section": {
"id": "7673c2b6-ca67-4571-b5f4-e1f1ad1cc5bf",
"name": "claim_information",
"label": "Claim Information",
"description": "Claim information section",
"ordering": 1,
"createdAt": "2023-07-13T03:07:05+00:00",
"updatedAt": "2023-07-13T03:07:05+00:00"
}
}
},
{
"id": "4bbf4ed7-45bf-4960-ae9b-95d83f6d06d4",
"claimId": "9826cebc-75c8-4a21-8472-9dd72223a201",
"sectionFieldId": "31df1c52-a33e-48fd-a030-d9f2504ae1fb",
"value": 0,
"createdAt": "2023-08-07T01:26:13+00:00",
"updatedAt": "2023-08-07T01:26:13+00:00",
"sectionField": {
"id": "31df1c52-a33e-48fd-a030-d9f2504ae1fb",
"sectionId": "e212e766-9905-4cee-ab57-bf1c4366cb1b",
"fieldTypeId": "598989f8-7379-479d-a0ea-de9df26c83a1",
"name": "declared_value",
"required": false,
"readOnly": true,
"isInternal": false,
"validation": null,
"options": null,
"meta": {
"label": "Declared Value",
"isFieldSummaryRequired": false
},
"ordering": 19,
"createdAt": "2023-07-13T03:07:05+00:00",
"updatedAt": "2023-07-13T03:07:05+00:00",
"validations": null,
"translatables": {
"label": true,
"description": true,
"placeholder": false,
"content": false,
"options": [],
"tooltip": true
},
"useDefaultTranslation": true,
"conditions": null,
"isPii": false,
"conditionAndOr": null,
"type": "numeric",
"section": {
"id": "e212e766-9905-4cee-ab57-bf1c4366cb1b",
"name": "claim_details",
"label": "Claim Details",
"description": "Rental Details Section",
"ordering": 2,
"createdAt": "2023-07-13T03:07:05+00:00",
"updatedAt": "2023-07-13T03:07:05+00:00"
}
}
}
]
}
}{
"claimTypeId": "ebc6af28-f2bb-4c10-a6db-1e821067453c",
"partnerId": "7f2f18eb-bee9-4760-ae39-94743ad7ddca",
"bookingReference": "JPJMU-KUXRX-INS",
"quoteReference": "034327ff-3687-4baf-ab25-68c5bdd24c60",
"language": "en",
"sectionFields": [
{
"name": "claimant_section",
"fields": [
{
"name": "first_name",
"value": "John"
},
{
"name": "middle_name",
"value": null
},
{
"name": "last_name",
"value": "Doe"
},
{
"name": "email",
"value": "[email protected]"
},
{
"name": "phone",
"value": null
},
{
"name": "date_of_birth",
"value": null
},
{
"name": "address1",
"value": "!009 Example Street"
},
{
"name": "address2",
"value": null
},
{
"name": "city",
"value": "Sydney"
},
{
"name": "state_province",
"value": "NSW"
},
{
"name": "postal_code",
"value": 2000
},
{
"name": "country",
"value": "AU"
}
]
},
{
"name": "claim_information",
"fields": [
{
"name": "description",
"value": "JPJMU-KUXRX-INS"
},
{
"name": "loss_at",
"value": "2023-07-01 03:08:36"
},
{
"name": "settlement_date",
"value": null
}
]
},
{
"name": "claim_details",
"fields": [
{
"name": "vehicle_registration",
"value": null
},
{
"name": "vehicle_registration_plate",
"value": null
},
{
"name": "driver_id",
"value": null
},
{
"name": "imei",
"value": null
},
{
"name": "color",
"value": null
},
{
"name": "shade",
"value": null
},
{
"name": "num_enum",
"value": null
},
{
"name": "declared_value",
"value": 0
},
{
"name": "pickup_date",
"value": null
}
]
}
]
}{
"type": "exception",
"message": "Could not create resource.",
"errors": {
"sectionFields.claimant_section.postal_code": [
"The Postal Code must be a string."
]
}
}When passing the wrong partner code (eg. S66VV instead of S76VV), returns a 403 response.
{
"claimTypeId": "ebc6af28-f2bb-4c10-a6db-1e821067453c",
"partnerId": "7f2f18eb-bee9-4760-ae39-94743ad7ddca",
"bookingReference": "JPJMU-KUXRX-INS",
"quoteReference": "034327ff-3687-4baf-ab25-68c5bdd24c60",
"language": "en",
"sectionFields": [
{
"name": "claimant_section",
"fields": [
{
"name": "first_name",
"value": "John"
},
{
"name": "middle_name",
"value": null
},
{
"name": "last_name",
"value": "Doe"
},
{
"name": "email",
"value": "[email protected]"
},
{
"name": "phone",
"value": null
},
{
"name": "date_of_birth",
"value": null
},
{
"name": "address1",
"value": "!009 Example Street"
},
{
"name": "address2",
"value": null
},
{
"name": "city",
"value": "Sydney"
},
{
"name": "state_province",
"value": "NSW"
},
{
"name": "postal_code",
"value": "2000"
},
{
"name": "country",
"value": "AU"
}
]
},
{
"name": "claim_information",
"fields": [
{
"name": "description",
"value": "JPJMU-KUXRX-INS"
},
{
"name": "loss_at",
"value": "2023-07-01 03:08:36"
},
{
"name": "settlement_date",
"value": null
}
]
},
{
"name": "claim_details",
"fields": [
{
"name": "vehicle_registration",
"value": null
},
{
"name": "vehicle_registration_plate",
"value": null
},
{
"name": "driver_id",
"value": null
},
{
"name": "imei",
"value": null
},
{
"name": "color",
"value": null
},
{
"name": "shade",
"value": null
},
{
"name": "num_enum",
"value": null
},
{
"name": "declared_value",
"value": 0
},
{
"name": "pickup_date",
"value": null
}
]
}
]
}{
"type": "exception",
"message": "Resource 'Partner' with given code S66VV does not have permission to access this route."
}Last updated