# CasePath IQ API

> Developer documentation for the CasePath IQ Partner API.

- [CasePath IQ Partner API](https://docs.casepathiq.com/index.md): Place and synchronize local-authority recovery Matters with CasePath IQ.
- [Plan your integration](https://docs.casepathiq.com/integration-planning.md): Map local-authority workflows to the v1 API and review proposed contract changes.
- [Core concepts](https://docs.casepathiq.com/concepts.md): Understand Matter identity, ownership, lifecycle, payments, and synchronization before integrating.
- [Authentication and environments](https://docs.casepathiq.com/authentication.md): Authenticate a partner integration and understand Client-scoped authorization.
- [Quickstart](https://docs.casepathiq.com/quickstart.md): Create a valid Matter in the CasePath IQ sandbox and safely retry the request.
- [Matter placement and updates](https://docs.casepathiq.com/matters.md): Create, replace, patch, and retrieve partner-owned Matter data.
- [Incremental synchronization](https://docs.casepathiq.com/synchronization.md): Pull changed Matter status using a stable updatedSince cursor and opaque page tokens.
- [Payments, corrections, and lifecycle](https://docs.casepathiq.com/payments-and-lifecycle.md): Record immutable payment evidence, correct opening balances, and change Matter lifecycle state.
- [Errors and safe retries](https://docs.casepathiq.com/errors-and-retries.md): Handle typed Problem Details responses, safe retries, and concurrent writes.
- [Get a Matter by client reference ID](https://docs.casepathiq.com/api-reference/matters/get-a-matter-by-client-reference-id.md)
- [Place or replace a Matter](https://docs.casepathiq.com/api-reference/matters/place-or-replace-a-matter.md): Creates a Matter on first valid PUT or fully replaces Integration-owned intake fields. Currency must equal the authorized Client currency and is immutable after creation. A full PUT may correct opening outstandingAmount only before recovery activity. Afterwards outstandingAmount must match the autho…
- [Patch a Matter](https://docs.casepathiq.com/api-reference/matters/patch-a-matter.md): Applies a closed JSON Merge Patch to Integration-owned fields. PATCH never creates a Matter and cannot change debt currency or amount. `parties` replaces the whole collection, so a patch that changes any Party's identity must carry complete recipient collections for every Party it sends.
- [Get a Matter by CasePath IQ ID](https://docs.casepathiq.com/api-reference/matters/get-a-matter-by-casepath-iq-id.md): Resolves the Matter within the authenticated Source integration and current Client grant. Wrong-Source, manual-intake, Legal matter referral, unknown, malformed, and cross-Client identifiers return a neutral 404.
- [List Matters changed since a timestamp](https://docs.casepathiq.com/api-reference/synchronization/list-matters-changed-since-a-timestamp.md): Returns a minimized current-state projection, not an event log. Results are restricted to the authenticated Source integration and current Client grant.
- [Get a Payment observation](https://docs.casepathiq.com/api-reference/payments/get-a-payment-observation.md): Resolves the observation by authenticated Source integration, clientCode, clientReferenceId, and externalPaymentId. Wrong-Source, wrong-Matter, manual-intake, Legal matter referral, malformed, unknown, and cross-Client identifiers return the same neutral 404.
- [Record a Payment observation](https://docs.casepathiq.com/api-reference/payments/record-a-payment-observation.md): Appends immutable payment, refund, or reversal evidence and updates the balance atomically under the Matter lock. A reversal must target one unreversed, non-reversal observation owned by the authenticated Source integration on the same Client and Matter, with an exact amount and currency match.
- [Pause a Matter](https://docs.casepathiq.com/api-reference/lifecycle/pause-a-matter.md)
- [Clear the current Source integration's pause](https://docs.casepathiq.com/api-reference/lifecycle/clear-the-current-source-integrations-pause.md): Requires the exact current pause created by the authenticated Source integration.
- [Close a Matter](https://docs.casepathiq.com/api-reference/lifecycle/close-a-matter.md)
- [Reopen a Matter closed by the current Source integration](https://docs.casepathiq.com/api-reference/lifecycle/reopen-a-matter-closed-by-the-current-source-integration.md): Requires the exact current close created by the authenticated Source integration and matching positive authoritative money.

## OpenAPI Specs

- [partner-api-v1](/openapi/partner-api-v1.yaml)


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