XClaim API Documentation for Partners (1.3.0)

Download OpenAPI specification:Download

Introduction

These are the API endpoints which may be required for integration.

The typical workflow would be to get claim types based on a policy type, and then ask the customer which claim type they would like to lodge. Afterwards, make a request to get he FNOL for that claim type.

Afterwards, you would orchestrate the collection of data from the customer for that claim type (based on the fields required - as returned by the FNOL), and when ready, create a new claim with that data. Any files should be uploaded beforehand, and their UUIDs used as the values of the respective FNOL data fields.

Appendix

Section Field Types

These are the section field types which are possible in the FNOL

  • string

    • return a string
  • email

  • date

    • return a string representation of a date (eg. "2019-03-25")
  • datetime

    • return a string representation of a date and time (eg. "2019-09-09 12:15:31")
  • numeric

    • return a number
  • url

    • return a valid url
  • boolean

    • return true or false (JSON boolean)
  • enum

    • return one of the options for the field (eg: "red")
  • geolocation

    • return a JSON object with lattitude and longitude properties
  • file

    • return array of file UUIDs, obtained from the file upload endpoint
  • set

    • return an array of selected options for the field
  • country

    • return a ISO 3166-2 country code (eg. "AU")
  • currency

    • return a ISO 4217 currency code (eg. "AUD")

Section Field Validations

These are the validations currently supported for a section field.

  • length

    • how short/long a string field should be
    • options: min, max
  • numeric

    • how low/high a numeric field should be
    • options min, max
  • multiselect

    • how many items should be included in an array (used with set fields)
    • options min, max
  • float

    • numeric field should include decimal(s)
    • no options

External Statuses

All claim statuses are grouped into a finite set of what we call "status groups" or "external categories", that are used for easier communicating the status of a claim. The follow is the list of these statuses:

  • Claim Submitted

  • Information Processing

  • Under Assessment

  • More Information Needed

  • Approved - Pending Payment

  • Approved - Payment Sent

  • Denied

Authentication

httpBearer

Security scheme type: HTTP
HTTP Authorization Scheme bearer

First Notice Of Loss

Resources related to getting a First Notice Of Loss form

Get Claim Types

Returns a list of claim types avaiable for the given policy type, and logged in user.

Use the id of the claim type you wish to make a claim for when requesting an FNOL

Authorizations:
path Parameters
partnerCode
required
string
policyTypeName
required
string
header Parameters
Content-Type
required
string
Example: "application/json"

Responses

200
404

Unexpected error in API call. See HTTP response body for details.

get /partners/{partnerCode}/policy-types/{policyTypeName}/claim-types
https://staging.api.xclaim.xcover.com//partners/{partnerCode}/policy-types/{policyTypeName}/claim-types

Response samples

application/json
Copy
Expand all Collapse all
{
  • "data":
    [
    ]
}

Get Fnol

Returns data required to build a form to collect data needed to submit a claim.

Each FNOL includes 1 to n sections which contain 1 to m sectionFields.

Each sectionField has a type, which you can use to build a form element and validate the data input by cutomers. Check the Appendix for the data types currently supported.

When submitting the claim, the data should match the field type, and any of the validations it contains. Check the Appendix for a list of possible validations.

Authorizations:
path Parameters
partnerCode
required
string
claimTypeUuid
required
string
header Parameters
Content-Type
required
string
Example: "application/json"

Responses

200
404

Unexpected error in API call. See HTTP response body for details.

get /partners/{partnerCode}/fnol/{claimTypeUuid}
https://staging.api.xclaim.xcover.com//partners/{partnerCode}/fnol/{claimTypeUuid}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "data":
    {
    }
}

Claims

Create a new Claim

Create a new claim by partner user.

Authorizations:
path Parameters
partnerCode
required
string
Request Body schema: application/json
claimTypeId
required
string
bookingReference
required
string
quoteReference
required
string
sectionFields
required
Array of objects (SectionField1)

Responses

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

Request samples

application/json
Copy
Expand all Collapse all
{
  • "claimTypeId": "46CFA81E-5820-44CB-AB01-637F8A8A8E2E",
  • "bookingReference": "129JJ-F3Y0Q-INS",
  • "quoteReference": "GJ275-F3ZZQ-QOT",
  • "sectionFields":
    [
    ]
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "id": "637eafba-f742-4661-bdfb-d8c6781d3b9d",
  • "claimTypeVersionId": "18bb9373-7a5e-430e-890d-dfa86add931a",
  • "partnerId": "46cfa81e-5820-44cb-ab01-637f8a8a8e2e",
  • "statusId": "099981f0-112a-48c9-9410-628feab2c360",
  • "claimReference": "XFJMG-3M6YA-CLA",
  • "bookingReference": "129JJ-F3Y0Q-INS",
  • "description": "Basic example claim.",
  • "reportedAt": "2018-11-27T23:33:38+00:00",
  • "lossAt": "2018-11-26T10:33:33+00:00",
  • "amount": "200.00",
  • "currency": "AUD",
  • "createdAt": "2018-11-27T23:33:39+00:00",
  • "updatedAt": "2018-11-27T23:33:39+00:00",
  • "status":
    {
    },
  • "claimDetails":
    [
    ],
  • "policy":
    {
    }
}

List of all claims

Returns a lits of all claims in the system from the given partner.

Authorizations:
path Parameters
partnerCode
required
string
header Parameters
Content-Type
required
string
Example: "application/json"

Responses

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

Response samples

application/json
Copy
Expand all Collapse all
{
  • "data":
    [
    ]
}

Update an existing Claim

Updates an existing claim

Authorizations:
path Parameters
partnerCode
required
string
claimUuid
required
string
Request Body schema: application/json
sectionFields
required
Array of objects (SectionField1)

Responses

200
patch /partners/{partnerCode}/claims/{claimUuid}
https://staging.api.xclaim.xcover.com//partners/{partnerCode}/claims/{claimUuid}

Request samples

application/json
Copy
Expand all Collapse all
{
  • "sectionFields":
    [
    ]
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "id": "637eafba-f742-4661-bdfb-d8c6781d3b9d",
  • "claimTypeVersionId": "18bb9373-7a5e-430e-890d-dfa86add931a",
  • "partnerId": "46cfa81e-5820-44cb-ab01-637f8a8a8e2e",
  • "statusId": "099981f0-112a-48c9-9410-628feab2c360",
  • "claimReference": "XFJMG-3M6YA-CLA",
  • "bookingReference": "129JJ-F3Y0Q-INS",
  • "description": "Basic example claim.",
  • "reportedAt": "2018-11-27T23:33:38+00:00",
  • "lossAt": "2018-11-26T10:33:33+00:00",
  • "amount": "200.00",
  • "currency": "AUD",
  • "createdAt": "2018-11-27T23:33:39+00:00",
  • "updatedAt": "2018-11-27T23:33:39+00:00",
  • "status":
    {
    },
  • "claimDetails":
    [
    ],
  • "policy":
    {
    }
}

Get Claim

Returns a single claim by Claim Uuid.

Authorizations:
path Parameters
partnerCode
required
string
claimUuid
required
string
header Parameters
Content-Type
required
string
Example: "application/json"

Responses

200
get /partners/{partnerCode}/claims/{claimUuid}
https://staging.api.xclaim.xcover.com//partners/{partnerCode}/claims/{claimUuid}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "data":
    {
    }
}

Claim Policy Details

Get policies details for a given claim.

Authorizations:
path Parameters
partnerCode
required
string
claimUuid
required
string
policyUuid
required
string
header Parameters
Content-Type
required
string
Example: "application/json"

Responses

200
get /partners{partnerCode}/claims/{claimUuid}/policies/{policyUuid}
https://staging.api.xclaim.xcover.com//partners{partnerCode}/claims/{claimUuid}/policies/{policyUuid}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "data":
    {
    }
}

List of claims by booking reference

Returns a lits of all claims in the system from the given partner by booking refernece.

Authorizations:
path Parameters
partnerCode
required
string
ins
required
string
header Parameters
Content-Type
required
string
Example: "application/json"

Responses

200
get /partners/{partnerCode}/bookings/{ins}/claims
https://staging.api.xclaim.xcover.com//partners/{partnerCode}/bookings/{ins}/claims

Response samples

application/json
Copy
Expand all Collapse all
{
  • "data":
    {
    }
}

List of claims by claim type

Returns a lits of all claims in the system from the given partner by claim type.

Authorizations:
path Parameters
partnerCode
required
string
claimTypeUuid
required
string
header Parameters
Content-Type
required
string
Example: "application/json"

Responses

200
get /partners/{partnerCode}/claim-types/{claimTypeUuid}/claims
https://staging.api.xclaim.xcover.com//partners/{partnerCode}/claim-types/{claimTypeUuid}/claims

Response samples

application/json
Copy
Expand all Collapse all
{
  • "claims":
    [
    ]
}

Upload File

Upload a File. Use the returned Id when submitting a claim to attach it to that claim.

Authorizations:
path Parameters
partnerCode
required
string
Request Body schema: multipart/form-data
file
required
string

Responses

201
422

Unexpected error in API call. See HTTP response body for details.

post /partners/{partnerCode}/files
https://staging.api.xclaim.xcover.com//partners/{partnerCode}/files

Request samples

multipart/form-data
Copy
{
  "file": "fileData"
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "id": "b4c3b092-d30c-4b1b-9a82-85b6936a4f4e",
  • "claimId": "637eafba-f742-4661-bdfb-d8c6781d3b9d",
  • "location": "claim_files/ef6d4a20-024f-11e9-986e-6781400cf929.png",
  • "createdAt": "2018-11-28T00:59:03+00:00",
  • "updatedAt": "2018-11-28T00:59:03+00:00"
}

Upload File Attached To Existing Claim

Upload a file with and attach it to a claim that has already been submitted

Authorizations:
path Parameters
partnerCode
required
string
claimUuid
required
string
Request Body schema: multipart/form-data
file
required
string

Responses

201
422

Unexpected error in API call. See HTTP response body for details.

post /partners/{partnerCode}/claims/{claimUuid}/files
https://staging.api.xclaim.xcover.com//partners/{partnerCode}/claims/{claimUuid}/files

Request samples

multipart/form-data
Copy
{
  "file": "fileData"
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "id": "b4c3b092-d30c-4b1b-9a82-85b6936a4f4e",
  • "claimId": "4ca40da3-4e5b-41d2-9924-cfb5eae609ce",
  • "location": "claim_files/ef6d4a20-024f-11e9-986e-6781400cf929.png",
  • "createdAt": "2018-11-28T00:59:03+00:00",
  • "updatedAt": "2018-11-28T00:59:03+00:00"
}

List of Files by Claim

Get a list of all files attach to a specific claim

Authorizations:
path Parameters
partnerCode
required
string
claimUuid
required
string
header Parameters
Content-Type
required
string
Example: "application/json"

Responses

200
get /partners/{partnerCode}/claims/{claimUuid}/files
https://staging.api.xclaim.xcover.com//partners/{partnerCode}/claims/{claimUuid}/files

Response samples

application/json
Copy
Expand all Collapse all
{
  • "data":
    [
    ]
}

Get File

Get the details of a single file

Authorizations:
path Parameters
partnerCode
required
string
claimUuid
required
string
fileUuid
required
string
header Parameters
Content-Type
required
string
Example: "application/json"

Responses

200
get /partners/{partnerCode}/claims/{claimUuid}/files/{fileUuid}
https://staging.api.xclaim.xcover.com//partners/{partnerCode}/claims/{claimUuid}/files/{fileUuid}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "data":
    {
    }
}

Delete File

Delete a file that is not currently attached to a claim

Authorizations:
path Parameters
partnerCode
required
string
fileUuid
required
string
header Parameters
Content-Type
required
string
Example: "application/json"

Responses

204
404

Unexpected error in API call. See HTTP response body for details.

delete /partners/{partnerCode}/files/{fileUuid}
https://staging.api.xclaim.xcover.com//partners/{partnerCode}/files/{fileUuid}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "message": "Resource 'ClaimFile' with given UUID b4c3b092-d30c-4b1b-9a82-85b6936a4f4e not found"
}