Start here
Quickstart
Configure a server-side API key and submit a physical-product claim.
Product access
Review the current Coming Soon state and access requirements.
Triage contract
Review supported domains, request fields, and result semantics.
API Reference
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 thephysical_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 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
A new successful completed POST records one
claim_triage Usage unit. GET does
not record Usage. See Usage and quotas.
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 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 ishttps://api.thewo.io; Staging is reserved for
internal validation. See Product access.