🛫
XClaim API Partner Docs
  • Introduction
  • Authentication
  • Claim Creation Workflows
    • Appendix
  • First Notice Of Loss (FNOL)
    • Get Claim Selector
    • Get Claim Types
    • Get Fnol
  • Claims
    • Create a new Claim
    • List of all claims
    • Update an existing Claim
    • Get Claim
    • Claim Policy Details
    • List of claims by booking reference
    • List of claims by claim type
    • Claim Files
      • Upload File
      • Upload File for an Existing Claim
      • List of Files by Claim
      • Get File
      • Delete File
  • Webhooks
    • Overview
    • Verifying signatures
    • Claim Webhooks
  • Integrations
    • Cancel For Any Reason (CFAR)
    • Claim Eligibility
      • Get Claim Eligibility Check
Powered by GitBook
On this page
  1. First Notice Of Loss (FNOL)

Get Claim Selector

Returns a Claim Selector that can be used to determine the best claim type for a customer to submit a claim for

You can display a decision point to a user (starting with the referenced one in decisionPointId) and use the answers to show more decision points until either a claim type id or a point with no answer is reached. Use the claim type id to get the FNOL for the user to submit a claim to.

Get Claim Selector

GET https://staging.api.xclaim.xcover.com/partners/{partnerCode}/claim-selectors/{claimSelectorUuid}

Returns a Claim Selector that can be used to determine the best claim type for a customer to submit a claim for

You can display a decision point to a user (starting with the referenced one in decisionPointId) and use the answers to show more decision points until either a claim type id or a point with no answer is reached. Use the claim type id to get the fnol for the user to submit a claim to.

Path Parameters

Name
Type
Description

partnerCode*

String

eg. XYZ999

claimSelectorUuid*

String

Claim selector uuid string

Headers

Name
Type
Description

Authorization*

String

Bearer {{JWT token}}

Content-Type*

String

application/json

{
    "data": {
        "id": "34ca7ecd-f42b-4add-b533-32464ae1b6ac",
        "name": "rental_cover_claim_selector",
        "label": "Rental Cover Claim Selector",
        "decisionPointId": "73989f90-10d8-4b56-8165-bcd9b1eab448",
        "active": true,
        "translationsCompletedAt": null,
        "isContentInXcms": false,
        "lastEditedBy": null,
        "decisionPoints": [
            {
                "id": "73989f90-10d8-4b56-8165-bcd9b1eab448",
                "claimSelectorId": "34ca7ecd-f42b-4add-b533-32464ae1b6ac",
                "label": "I'd like to make a claim because",
                "description": "What was the main reason for making this claim",
                "type": "enum",
                "claimTypeId": null,
                "name": "I'd like to make a claim because",
                "decisionAnswers": [
                    {
                        "id": "6820113f-cac2-47b5-8c45-3fe190ccb622",
                        "decisionPointId": "73989f90-10d8-4b56-8165-bcd9b1eab448",
                        "value": "My rental car was damaged",
                        "logic": null,
                        "linksTo": "c30e77e5-7bcf-4351-820b-5881d6eb761a",
                        "ordering": 0,
                        "name": null
                    },
                    {
                        "id": "9fad2078-368b-4de2-a8bb-81eaf2888922",
                        "decisionPointId": "73989f90-10d8-4b56-8165-bcd9b1eab448",
                        "value": "My rental car was stolen",
                        "logic": null,
                        "linksTo": "08b264cd-2368-4b13-97ab-aa8c7ec69504",
                        "ordering": 0,
                        "name": null
                    },
                    {
                        "id": "615006a1-aa5f-4d42-8e68-685c7097767e",
                        "decisionPointId": "73989f90-10d8-4b56-8165-bcd9b1eab448",
                        "value": "Actually my enquiry is unrelated to any car rental damage/s",
                        "logic": null,
                        "linksTo": "f9cf56e7-f81f-4847-99fa-1d568c8a466e",
                        "ordering": 0,
                        "name": null
                    }
                ]
            },
            {
                "id": "c30e77e5-7bcf-4351-820b-5881d6eb761a",
                "claimSelectorId": "34ca7ecd-f42b-4add-b533-32464ae1b6ac",
                "label": "In your opinion, who was responsible for the damages?",
                "description": null,
                "type": "enum",
                "claimTypeId": null,
                "name": "In your opinion, who was responsible for the damages?",
                "decisionAnswers": [
                    {
                        "id": "2f41affb-ce33-469c-be8c-d988c676384c",
                        "decisionPointId": "c30e77e5-7bcf-4351-820b-5881d6eb761a",
                        "value": "Myself",
                        "logic": null,
                        "linksTo": "0b3fc7c0-7786-4e70-884b-b04a6351ca34",
                        "ordering": 0,
                        "name": null
                    },
                    {
                        "id": "c0b23368-b23e-4945-828b-855e6eae4df2",
                        "decisionPointId": "c30e77e5-7bcf-4351-820b-5881d6eb761a",
                        "value": "Another driver on the rental agreement",
                        "logic": null,
                        "linksTo": "0b3fc7c0-7786-4e70-884b-b04a6351ca34",
                        "ordering": 0,
                        "name": null
                    },
                    {
                        "id": "9d12247f-b862-4a57-a3bc-108501318a32",
                        "decisionPointId": "c30e77e5-7bcf-4351-820b-5881d6eb761a",
                        "value": "Another driver",
                        "logic": null,
                        "linksTo": "53a83dc5-fa20-415e-9bf0-bb9b255b6cb7",
                        "ordering": 0,
                        "name": null
                    },
                    {
                        "id": "1aa48198-e93f-41a7-9269-1907570aa414",
                        "decisionPointId": "c30e77e5-7bcf-4351-820b-5881d6eb761a",
                        "value": "Not sure",
                        "logic": null,
                        "linksTo": "0b3fc7c0-7786-4e70-884b-b04a6351ca34",
                        "ordering": 0,
                        "name": null
                    }
                ]
            },
            {
                "id": "0b3fc7c0-7786-4e70-884b-b04a6351ca34",
                "claimSelectorId": "34ca7ecd-f42b-4add-b533-32464ae1b6ac",
                "label": "In your opinion, was the amount charged by the rental company reasonable given the damage to the vehicle?",
                "description": null,
                "type": "boolean",
                "claimTypeId": null,
                "name": "In your opinion, was the amount charged by the rental company reasonable given the damage to the vehicle?",
                "decisionAnswers": [
                    {
                        "id": "9fce4a80-1d0f-451a-824f-176b268f9476",
                        "decisionPointId": "0b3fc7c0-7786-4e70-884b-b04a6351ca34",
                        "value": "Yes",
                        "logic": null,
                        "linksTo": "90f78e81-b842-40b5-8d97-ad163673bba2",
                        "ordering": 0,
                        "name": null
                    },
                    {
                        "id": "f43724b6-59a3-48dd-992d-bc3e77be7529",
                        "decisionPointId": "0b3fc7c0-7786-4e70-884b-b04a6351ca34",
                        "value": "No",
                        "logic": null,
                        "linksTo": "8d031e2e-8acd-46bd-9ed1-8ae0dc13a7c2",
                        "ordering": 0,
                        "name": null
                    }
                ]
            },
            {
                "id": "90f78e81-b842-40b5-8d97-ad163673bba2",
                "claimSelectorId": "34ca7ecd-f42b-4add-b533-32464ae1b6ac",
                "label": null,
                "description": null,
                "type": null,
                "claimTypeId": "0ffa108a-10ce-40f4-b470-a12d6b38bcc5",
                "name": "decision_point_4",
                "decisionAnswers": []
            },
            {
                "id": "8d031e2e-8acd-46bd-9ed1-8ae0dc13a7c2",
                "claimSelectorId": "34ca7ecd-f42b-4add-b533-32464ae1b6ac",
                "label": null,
                "description": null,
                "type": null,
                "claimTypeId": "0ffa108a-10ce-40f4-b470-a12d6b38bcc5",
                "name": "decision_point_5",
                "decisionAnswers": []
            },
            {
                "id": "53a83dc5-fa20-415e-9bf0-bb9b255b6cb7",
                "claimSelectorId": "34ca7ecd-f42b-4add-b533-32464ae1b6ac",
                "label": "In your opinion, was the amount charged by the rental company reasonable given the damage to the vehicle?",
                "description": null,
                "type": "boolean",
                "claimTypeId": null,
                "name": "In your opinion, was the amount charged by the rental company reasonable given the damage to the vehicle?",
                "decisionAnswers": [
                    {
                        "id": "2c052b63-31e7-4b5e-bc97-10f6ef92c84a",
                        "decisionPointId": "53a83dc5-fa20-415e-9bf0-bb9b255b6cb7",
                        "value": "Yes",
                        "logic": null,
                        "linksTo": "f817efb0-0b13-47e1-997f-0312dc5ee2e9",
                        "ordering": 0,
                        "name": null
                    },
                    {
                        "id": "f141bedd-d004-43fc-8317-496fce22ed3a",
                        "decisionPointId": "53a83dc5-fa20-415e-9bf0-bb9b255b6cb7",
                        "value": "No",
                        "logic": null,
                        "linksTo": "dbfac850-0e69-49a3-b4b8-2359d89b284e",
                        "ordering": 0,
                        "name": null
                    }
                ]
            },
            {
                "id": "f817efb0-0b13-47e1-997f-0312dc5ee2e9",
                "claimSelectorId": "34ca7ecd-f42b-4add-b533-32464ae1b6ac",
                "label": null,
                "description": null,
                "type": null,
                "claimTypeId": "0ffa108a-10ce-40f4-b470-a12d6b38bcc5",
                "name": "decision_point_6",
                "decisionAnswers": []
            },
            {
                "id": "dbfac850-0e69-49a3-b4b8-2359d89b284e",
                "claimSelectorId": "34ca7ecd-f42b-4add-b533-32464ae1b6ac",
                "label": null,
                "description": null,
                "type": null,
                "claimTypeId": "0ffa108a-10ce-40f4-b470-a12d6b38bcc5",
                "name": "decision_point_7",
                "decisionAnswers": []
            },
            {
                "id": "08b264cd-2368-4b13-97ab-aa8c7ec69504",
                "claimSelectorId": "34ca7ecd-f42b-4add-b533-32464ae1b6ac",
                "label": null,
                "description": null,
                "type": null,
                "claimTypeId": "0ffa108a-10ce-40f4-b470-a12d6b38bcc5",
                "name": "decision_point_8",
                "decisionAnswers": []
            },
            {
                "id": "f9cf56e7-f81f-4847-99fa-1d568c8a466e",
                "claimSelectorId": "34ca7ecd-f42b-4add-b533-32464ae1b6ac",
                "label": "I actually just need:",
                "description": "What was the main reason for making this claim",
                "type": "enum",
                "claimTypeId": null,
                "name": "I actually just need:",
                "decisionAnswers": [
                    {
                        "id": "caf19f2f-2456-478c-ac7c-20e239454b79",
                        "decisionPointId": "f9cf56e7-f81f-4847-99fa-1d568c8a466e",
                        "value": "Help with an unrecognized credit card charge",
                        "logic": null,
                        "linksTo": "f11f53e7-ea0e-4616-84f5-ce25ccb1be4b",
                        "ordering": 0,
                        "name": null
                    },
                    {
                        "id": "4680bba7-c1a6-44fc-b24a-b3ca3c8f7aca",
                        "decisionPointId": "f9cf56e7-f81f-4847-99fa-1d568c8a466e",
                        "value": "A refund",
                        "logic": null,
                        "linksTo": "b23508aa-ef33-4be0-93e4-c7367032a3c7",
                        "ordering": 0,
                        "name": null
                    },
                    {
                        "id": "f94cac8a-504b-46a0-bba4-e6109328699e",
                        "decisionPointId": "f9cf56e7-f81f-4847-99fa-1d568c8a466e",
                        "value": "To make changes to my car booking",
                        "logic": null,
                        "linksTo": "f11f53e7-ea0e-4616-84f5-ce25ccb1be4b",
                        "ordering": 0,
                        "name": null
                    },
                    {
                        "id": "51eb0aa4-aec9-4011-ac82-9551f0dbb023",
                        "decisionPointId": "f9cf56e7-f81f-4847-99fa-1d568c8a466e",
                        "value": "To make changes to my insurance from RentalCover.com",
                        "logic": null,
                        "linksTo": "eb54d637-5060-4340-a2af-8b35efa347e2",
                        "ordering": 0,
                        "name": null
                    }
                ]
            },
            {
                "id": "f11f53e7-ea0e-4616-84f5-ce25ccb1be4b",
                "claimSelectorId": "34ca7ecd-f42b-4add-b533-32464ae1b6ac",
                "label": "Thank you!",
                "description": "{{IF B2B}}: <a href=\"/help/car-rental/139\">Our Help {{IS US}} Center {{/IF}} {{IF !US}} Centre {{/IF}}</a> has contact details for {PartnerName} - they are booking agents for {SuplierName}.{{/IF}}{{IF !B2B}} To resolve your request you will need to contact the rental company.{{/IF}}",
                "type": null,
                "claimTypeId": null,
                "name": "Thank you!",
                "decisionAnswers": []
            },
            {
                "id": "b23508aa-ef33-4be0-93e4-c7367032a3c7",
                "claimSelectorId": "34ca7ecd-f42b-4add-b533-32464ae1b6ac",
                "label": "Thank you!",
                "description": "{{IF B2B}}: <a href=\"/help/car-rental/139\">Our Help {{IS US}} Center {{/IF}} {{IF !US}} Centre {{/IF}}</a> has contact details for {PartnerName} - they are booking agents for {SuplierName}.{{/IF}}{{IF !B2B}} Please login to your <a href=\"/account\">RentalCover.com Account</a> to manage your policy. If prompted, you will need to enter your policy number: {booking_reference}{{/IF}}",
                "type": null,
                "claimTypeId": null,
                "name": "Thank you!",
                "decisionAnswers": []
            },
            {
                "id": "eb54d637-5060-4340-a2af-8b35efa347e2",
                "claimSelectorId": "34ca7ecd-f42b-4add-b533-32464ae1b6ac",
                "label": "Thank you!",
                "description": "Please login to your <a href=\"/account\">RentalCover.com Account</a> to manage your policy. If prompted, you will need to enter your policy number: {booking_reference}",
                "type": null,
                "claimTypeId": null,
                "name": "Thank you!",
                "decisionAnswers": []
            }
        ],
        "locales": [],
        "lastEditedByUser": null
    }
}

{
    "type": "exception",
    "message": "Claim selector with given ID could not found."
}

PreviousFirst Notice Of Loss (FNOL)NextGet Claim Types

Last updated 1 year ago