> ## Documentation Index
> Fetch the complete documentation index at: https://docs.casepathiq.com/llms.txt
> Use this file to discover all available pages before exploring further.

# CasePath IQ Partner API

> Place and synchronize local-authority recovery Matters with CasePath IQ.

> [!NOTE]
>
> Sandbox is available at [https://api.sandbox.casepathiq.com](https://api.sandbox.casepathiq.com). Use your scoped API key and synthetic data. Production onboarding is separate.

The CasePath IQ Partner API lets approved partner systems place legal-recovery Matters, keep partner-owned facts current, report external payments, and synchronize operational status.

## How to use these docs

Start with [Plan your integration](https://docs.casepathiq.com/integration-planning.md) to check whether v1 covers your data and to review proposed contract changes before committing an implementation.

1. **Read [Core concepts](https://docs.casepathiq.com/concepts.md)** to understand identifiers, ownership, lifecycle, payments, and synchronization.
2. **Configure [Authentication](https://docs.casepathiq.com/authentication.md)** for the correct environment and Client grants.
3. **Run the [Quickstart](https://docs.casepathiq.com/quickstart.md)** to create and read one sandbox Matter.
4. **Implement the workflow guides** for [Matters](https://docs.casepathiq.com/matters.md), [Synchronization](https://docs.casepathiq.com/synchronization.md), and [Payments and lifecycle](https://docs.casepathiq.com/payments-and-lifecycle.md).
5. **Handle [Errors and retries](https://docs.casepathiq.com/errors-and-retries.md)** before using the API reference for exact paths, fields, enums, and response shapes.

The guides explain intent and safe integration behaviour. The generated reference is the field-level contract.

The API accepts one or more debtor Parties and one debt total per Matter. Multiple Debt items, further-instruction records, document transfer, and last/next-action reporting need contract decisions before they can be sent or requested. Successful intake does not authorize legal work: the MVP requires Firm staff approval of the current Matter revision before workflow entry.

## Integration flow

**1. Receive access**

CasePath IQ provisions a sandbox Bearer key and grants the Source integration access to one or more Client codes.

**2. Place a Matter**

Create a Matter at the stable URL formed from the Client code and your client reference ID.

**3. Send evidence and instructions**

Replace or patch partner-owned intake facts, record immutable Payment observations, and submit explicit lifecycle commands.

**4. Synchronize status**

Read individual Matters or pull minimized current-state changes with the required `updatedSince` boundary.

Every write is validated and applied synchronously. Invalid or unsafe data is rejected without a partial state change.

## Phase 1 capabilities

| Capability | Guide |
| - | - |
| Create, replace, patch, and retrieve Matters | [Matters](https://docs.casepathiq.com/matters.md) |
| Authenticate and use Client-scoped access | [Authentication](https://docs.casepathiq.com/authentication.md) |
| Pull changed current state | [Synchronization](https://docs.casepathiq.com/synchronization.md) |
| Record payments, refunds, and reversals | [Payments and lifecycle](https://docs.casepathiq.com/payments-and-lifecycle.md#payment-observations) |
| Pause, close, clear, and reopen Matters | [Payments and lifecycle](https://docs.casepathiq.com/payments-and-lifecycle.md#lifecycle-operations) |
| Handle typed errors and safe retries | [Errors and retries](https://docs.casepathiq.com/errors-and-retries.md) |

## Rules to design around

* The partner owns `clientReferenceId`; CasePath IQ owns `matterId`.
* Partner keys authenticate integrations; current grants authorize each `clientCode`.
* Matter PUT and PATCH requests contain no caller revision or idempotency header.
* Payment observations are immutable evidence. Corrections use reversal plus a new observation.
* Lifecycle commands target the current server-issued `lifecycleStateId`.
* List sync is a minimized current-state projection, not an event log, and excludes Party data.

## Outside Phase 1

Bulk import, outbound webhooks, document transfer, PracticeEvolve forwarding, public reconciliation exports, SDKs, caller-supplied revisions, and caller `Idempotency-Key` headers are not part of Phase 1.


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