🛫
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

Introduction

This document describes the API resources in the XClaim product, available for Cover Genius partners to use within it's ecosystem.

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

Afterward, 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.

API Overview

This is a JSON REST API, which aims to be compatible with the JSON:API specification.

When making API requests, please use application/json in the Content-Type header.

In terms of authentication, you should obtain a JWT, as described in the Authentication page. You should use it in the Authorization header like so;

Bearer <TOKEN>

Internationalization

XClaim supports seamless translations for all content that is customer-facing. However, not all content is translated (and not to every language) by default - it depends on your specific use cases. This is something to discuss with the partnerships team.

If you are in a situation where you are supporting multiple languages, you can ensure that XClaim returns translated content, by using the Accept-Language header. The specific locales supported, depend on your integration.

Some examples;

  • Accept-Language: zh-hans

  • Accept-Language: zh-hant_tw

  • Accept-Language: ru

  • Accept-Language: pt-br

The default locale for our platform is en.

Dates & Timestamps

When parsing timestamps, ours will be output in an ISO 8601 format, so if you are parsing any timestamp, be sure your parser supports the full standard. For example, a timestamp may be 2025-02-26T09:31:27Z , 2025-02-26T09:31:27.00000Z`or 2025-02-25T21:31:27−12:00as well as others described in the ISO standard.

NextAuthentication

Last updated 2 months ago