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

# ClaimReady

> Triage physical-product warranty and return claims through The Wo API.

**Turn a physical-product warranty or return claim into structured guidance for human review.**

ClaimReady evaluates customer-supplied claim, product, purchase, evidence, and
policy details. It returns apparent eligibility, review disposition, missing
evidence, risk signals, and a suggested next step. The result supports a
workflow; it does not decide a claim.

## Start here

> [card] [Quickstart](https://docs.thewo.io/claim-ready/quickstart.md)
>
> Configure a server-side API key and submit a physical-product claim.

> [card] [Product access](https://docs.thewo.io/claim-ready/guides/product-access.md)
>
> Review the current Coming Soon state and access requirements.

> [card] [Triage contract](https://docs.thewo.io/claim-ready/guides/triage-contract.md)
>
> Review supported domains, request fields, and result semantics.

> [card] [API Reference](https://docs.thewo.io/claim-ready/api-reference/overview.md)
>
> Explore the OpenAPI request, response, and error definitions.

## Product goal

Warranty and return requests bring together product facts, purchase details,
policies, and evidence that need a structured review package. ClaimReady
evaluates those supplied details and returns decision-support information for
a human reviewer; it does not decide the claim or establish entitlement to a
remedy.

## Current capabilities

The current v1 contract supports warranty and return triage for the
`physical_product` domain. Other recognized claim domains are not supported for
triage. A supported request can complete even when purchase records, policy
terms, or evidence are incomplete; the result identifies relevant gaps.

The API exposes a synchronous triage operation and customer-scoped retrieval
of a triage by ID. It uses shared API-key authentication, entitlement, rate
limits, idempotency, quota, and Usage controls.

## Current API lifecycle

For a new POST, the API authenticates the customer, applies rate limiting,
validates the request and claim domain, checks product entitlement, reserves
idempotency, and checks quota. It then acquires any supplied remote evidence,
interprets it when needed, evaluates the supplied structured policy
deterministically, persists the completed triage, records Usage, and returns a
safe response. Retrieval is a separate customer-owned GET operation.

## Shared platform boundary

ClaimReady owns the claim vocabulary, request and result contract, and supported
scenario boundary. The shared platform provides API-key authentication,
entitlement, rate limiting, idempotency, quota, and Usage. See shared
[Authentication](https://docs.thewo.io/platform/authentication.md) guidance.

## API version

The public routes use URL versioning under `/v1`. Backward-incompatible public
contract changes are not introduced silently within an existing API version.

## Current endpoints

| Method | Endpoint | Purpose |
| - | - | - |
| `POST` | `/v1/product-claims/triage` | Create or replay a triage result. |
| `GET` | `/v1/product-claims/{id}` | Retrieve a triage owned by the authenticated customer. |

A new successful completed POST records one `claim_triage` Usage unit. GET does
not record Usage. See [Usage and quotas](https://docs.thewo.io/claim-ready/guides/usage-and-quotas.md).

## Decision-support boundary

ClaimReady does not approve or deny claims, determine fraud, adjudicate
insurance or legal matters, authorize refunds, or replace a human decision.
A risk flag is a signal to review, not a fraud finding. See the
[triage contract](https://docs.thewo.io/claim-ready/guides/triage-contract.md) before using outputs in
your workflow.

## Availability

ClaimReady is currently **Coming Soon**. Publishing these docs does not grant
access or create a public self-service activation path. The canonical
production API origin is `https://api.thewo.io`; Staging is reserved for
internal validation. See [Product access](https://docs.thewo.io/claim-ready/guides/product-access.md).

## Continue exploring

* [Quickstart](https://docs.thewo.io/claim-ready/quickstart.md)
* [Triage contract](https://docs.thewo.io/claim-ready/guides/triage-contract.md)
* [Usage and quotas](https://docs.thewo.io/claim-ready/guides/usage-and-quotas.md)
* [Errors](https://docs.thewo.io/claim-ready/guides/errors.md)
* [TypeScript example](https://docs.thewo.io/claim-ready/examples/typescript.md)
* [API Reference](https://docs.thewo.io/claim-ready/api-reference/overview.md)


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