Quickstart

Submit one physical-product claim and receive a completed triage result for human review.

Before you start

ClaimReady is currently Coming Soon. There is no public plan or self-service activation path, and publishing these docs does not grant product access. To prepare, you need a The Wo account and Workspace, an active ClaimReady entitlement, a Developer API key, and a trusted server environment where the key can remain secret. Read Product access and Authentication. Never commit an API key, put it in a URL, log it, or embed it in browser or mobile code.

Configure your environment

Use the production origin for customer integrations. Staging is reserved for internal The Wo release validation.

export THE_WO_API_BASE_URL="https://api.thewo.io"
export THE_WO_API_KEY="replace-with-your-api-key"

Submit a triage request

This synthetic example describes a blender warranty claim. claimDomain is required and must explicitly be physical_product for supported triage.

curl \
  --request POST \
  --url "$THE_WO_API_BASE_URL/v1/product-claims/triage" \
  --header "content-type: application/json" \
  --header "x-api-key: $THE_WO_API_KEY" \
  --header "Idempotency-Key: blender-warranty-001" \
  --data '{
    "claimDomain": "physical_product",
    "claimType": "warranty",
    "product": { "name": "Example blender", "model": "B-100" },
    "issue": { "description": "The motor stops during normal use." },
    "purchase": { "purchasedAt": "2026-02-10", "seller": "Example Shop" },
    "language": "en"
  }'

The body is strict: unknown fields are rejected. claimType is warranty or return. language is optional and supports en, es, or pt, defaulting to en. Purchase, evidence, and policy details are optional. A missing fact can be reported in a successful result instead of making the request invalid. See the full triage contract.

Read the result

A successful new request returns 201 Created. The response includes the safe triage resource and one Usage unit. The synthetic response below follows the supplied request. Its timestamps and resource ID are illustrative:

{
  "id": "claim_triage_example_01",
  "status": "completed",
  "input": {
    "claimDomain": "physical_product",
    "claimType": "warranty",
    "product": { "name": "Example blender", "model": "B-100" },
    "purchase": { "purchasedAt": "2026-02-10", "seller": "Example Shop" },
    "purchaseDocumentSupplied": false,
    "issue": { "description": "The motor stops during normal use." },
    "evidenceSupplied": false,
    "evidenceTypes": [],
    "policyDocumentSupplied": false,
    "language": "en"
  },
  "result": {
    "claimType": "warranty",
    "apparentEligibility": "undetermined",
    "reviewDisposition": "manual_review_required",
    "policyMatches": [
      {
        "code": "purchase_inside_warranty_window",
        "status": "unknown",
        "description": "The supplied structured warranty window cannot be compared with a reliable purchase date."
      }
    ],
    "missingEvidence": [
      {
        "code": "applicable_policy",
        "description": "A structured policy window for this claim type was not supplied."
      }
    ],
    "riskFlags": [],
    "suggestedNextStep": {
      "code": "manual_policy_review"
    },
    "confidence": 0.55
  },
  "usage": { "operation": "claim_triage", "units": 1 },
  "createdAt": "2026-10-31T12:00:00.000Z",
  "updatedAt": "2026-10-31T12:00:00.000Z"
}

The result is advisory. undetermined is not a denial and manual_review_required is not a failed request. Confidence is not the probability that a claim is true. See Errors if the request fails.

Retrieve the result

Use the returned ID to retrieve the same customer’s resource. GET returns the resource without new Usage metadata and does not require the POST entitlement check.

curl \
  --url "$THE_WO_API_BASE_URL/v1/product-claims/claim_triage_example_01" \
  --header "x-api-key: $THE_WO_API_KEY"

Handle errors

Errors use the shared safe envelope. For example, a malformed request can return 400:

{
  "error": {
    "code": "invalid_request_payload",
    "message": "Request body is invalid.",
    "requestId": "req_example_01"
  }
}

Use error.code to handle the failure and retain requestId when seeking support. For a retry of the same POST request, reuse its Idempotency-Key. See the Errors guide for status codes and retry behavior.

Next steps

Read the triage contract.
Review Usage and quotas and Errors.
Browse the TypeScript example and API Reference.

Overview

Getting started

Product guides

Examples

Quickstart

Quickstart

Before you start

Configure your environment

Submit a triage request

Read the result

Retrieve the result

Handle errors

Next steps

​Quickstart

​Before you start

​Configure your environment

​Submit a triage request

​Read the result

​Retrieve the result

​Handle errors

​Next steps

Quickstart

Before you start

Configure your environment

Submit a triage request

Read the result

Retrieve the result

Handle errors

Next steps