> ## Documentation Index
> Fetch the complete documentation index at: https://claimsdesk-871aefc7.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> Welcome to the Claims Desk API documentation and integration reference.

> [!NOTE]
>
> **Demo Environment Notice**: This public API reference represents a demonstration deployment of ClaimsDesk. The solution is architected and built to be deployed **on-premises** within the client's private infrastructure rather than as a multi-tenant public SaaS application.

## Overview

The **ClaimsDesk API** provides a complete set of RESTful services powering:

* **Web Portals**: Claims adjusters, branch supervisors, and administrative dashboards.
* **Mobile Applications**: Field staff, investigators, and member self-service applications.
* **Third-Party Vendors & Integration Partners**: External repair facilities, medical assessment providers, legal partners, and core enterprise systems.

All endpoints adhere to REST principles, accepting and returning standard JSON payloads with comprehensive validation and descriptive error structures.

***

## Architecture & Authentication

ClaimsDesk supports secure API access via header-based authentication:

```http theme={null}
X-App-Id: <your-application-id>
X-Api-Key: <your-secret-api-key>
```

Alternatively, user sessions initiated through web portals utilize standard Bearer JWT tokens:

```http theme={null}
Authorization: Bearer <jwt-token>
```

> **Interactive API Playground**
>
> Test every request directly within this documentation using the built-in request runner.

> **Role-Based Security**
>
> Fine-grained permissions and approval limits applied to all user actions.

***

## Logical API Domains

The API endpoints are organized into the following logical business domains:

1. **User & Access Management**: Manage internal users, roles, and granular permission assignments.
2. **Tenant & Organizations**: Configure tenant organizations, corporate structures, and branch offices.
3. **Policyholders & Members**: Maintain primary customer profiles, covered members, and beneficiaries.
4. **Insurance & Underwriting**: Complete insurance policy lifecycle management, coverage entitlements, and contribution receipts.
5. **Subscriptions & Licensing**: Manage subscription tiers, license quota pools, and seat assignments.
6. **Developer & System Security**: Provision API keys and inspect audit trail compliance logs.
7. **Analytics & Reporting**: Run parameterized report previews, generate snapshots, and export reports in PDF or CSV formats.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.