Create a claim triage - The Wo Developer Platform

POST

product-claims

triage

Create a claim triage

curl --request POST \
  --url https://api.thewo.io/v1/product-claims/triage \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "claimDomain": "physical_product",
  "claimType": "warranty",
  "product": {
    "name": "Example blender",
    "model": "B-100"
  },
  "issue": {
    "description": "The motor stops during normal use."
  }
}
'

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    'x-api-key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    claimDomain: 'physical_product',
    claimType: 'warranty',
    product: {name: 'Example blender', model: 'B-100'},
    issue: {description: 'The motor stops during normal use.'}
  })
};

fetch('https://api.thewo.io/v1/product-claims/triage', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "<string>",
  "status": "completed",
  "input": {
    "claimDomain": "physical_product",
    "claimType": "warranty",
    "product": {
      "name": "<string>",
      "model": "<string>",
      "serialNumber": "<string>",
      "category": "<string>",
      "manufacturer": "<string>",
      "externalProductId": "<string>"
    },
    "purchaseDocumentSupplied": true,
    "issue": {
      "description": "<string>"
    },
    "evidenceSupplied": true,
    "evidenceTypes": [
      "image"
    ],
    "policyDocumentSupplied": true,
    "purchase": {
      "purchasedAt": "2023-12-25",
      "seller": "<string>",
      "externalOrderId": "<string>",
      "amount": {
        "minorUnits": 123,
        "currency": "<string>"
      }
    },
    "policy": {
      "policyType": "warranty",
      "externalPolicyId": "<string>",
      "version": "<string>",
      "text": "<string>",
      "warrantyWindowDays": 4503599627370495,
      "returnWindowDays": 4503599627370495,
      "conditions": [
        "<string>"
      ],
      "exclusions": [
        "<string>"
      ],
      "requiredEvidence": [
        "proof_of_purchase"
      ]
    },
    "language": "en"
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "usage": {
    "operation": "claim_triage",
    "units": 1
  },
  "result": {
    "claimType": "warranty",
    "apparentEligibility": "potentially_eligible",
    "reviewDisposition": "review_ready",
    "policyMatches": [
      {
        "code": "purchase_inside_warranty_window",
        "status": "satisfied",
        "description": "<string>"
      }
    ],
    "missingEvidence": [
      {
        "code": "proof_of_purchase",
        "description": "<string>"
      }
    ],
    "riskFlags": [
      {
        "code": "evidence_inconsistent"
      }
    ],
    "suggestedNextStep": {
      "code": "request_proof_of_purchase",
      "explanation": "<string>"
    },
    "confidence": 0.5
  }
}

Authorizations

x-api-key

string

header

required

Headers

Idempotency-Key

string

required

1–255 characters. Reuse for retries of the same material request.

Required string length: 1 - 255

Body

application/json

claimDomain

enum<string>

required

Available options:

physical_product,

insurance,

personal_injury,

medical_claim,

vehicle_accident_liability,

financial_dispute,

legal_damages,

bodily_harm

claimType

enum<string>

required

Available options:

warranty,

return

product

object

required

Show child attributes

issue

object

required

Show child attributes

purchase

object

Show child attributes

evidence

object

Show child attributes

policy

object

Customer-supplied policy context for this triage. ClaimReady does not invent warranty or legal rules. Structured policy fields can guide deterministic comparisons when enough request facts are available; free-form text, conditions, and exclusions are preserved as context and are not an executable rules language.

Show child attributes

language

enum<string>

Available options:

en,

es,

pt

Response

Completed triage created or replayed.

string

required

status

string

required

Allowed value: "completed"

input

object

required

Show child attributes

createdAt

string<date-time>

required

updatedAt

string<date-time>

required

usage

object

required

Show child attributes

result

object

Show child attributes

Create a claim triage

curl --request POST \
  --url https://api.thewo.io/v1/product-claims/triage \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "claimDomain": "physical_product",
  "claimType": "warranty",
  "product": {
    "name": "Example blender",
    "model": "B-100"
  },
  "issue": {
    "description": "The motor stops during normal use."
  }
}
'

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    'x-api-key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    claimDomain: 'physical_product',
    claimType: 'warranty',
    product: {name: 'Example blender', model: 'B-100'},
    issue: {description: 'The motor stops during normal use.'}
  })
};

fetch('https://api.thewo.io/v1/product-claims/triage', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "<string>",
  "status": "completed",
  "input": {
    "claimDomain": "physical_product",
    "claimType": "warranty",
    "product": {
      "name": "<string>",
      "model": "<string>",
      "serialNumber": "<string>",
      "category": "<string>",
      "manufacturer": "<string>",
      "externalProductId": "<string>"
    },
    "purchaseDocumentSupplied": true,
    "issue": {
      "description": "<string>"
    },
    "evidenceSupplied": true,
    "evidenceTypes": [
      "image"
    ],
    "policyDocumentSupplied": true,
    "purchase": {
      "purchasedAt": "2023-12-25",
      "seller": "<string>",
      "externalOrderId": "<string>",
      "amount": {
        "minorUnits": 123,
        "currency": "<string>"
      }
    },
    "policy": {
      "policyType": "warranty",
      "externalPolicyId": "<string>",
      "version": "<string>",
      "text": "<string>",
      "warrantyWindowDays": 4503599627370495,
      "returnWindowDays": 4503599627370495,
      "conditions": [
        "<string>"
      ],
      "exclusions": [
        "<string>"
      ],
      "requiredEvidence": [
        "proof_of_purchase"
      ]
    },
    "language": "en"
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "usage": {
    "operation": "claim_triage",
    "units": 1
  },
  "result": {
    "claimType": "warranty",
    "apparentEligibility": "potentially_eligible",
    "reviewDisposition": "review_ready",
    "policyMatches": [
      {
        "code": "purchase_inside_warranty_window",
        "status": "satisfied",
        "description": "<string>"
      }
    ],
    "missingEvidence": [
      {
        "code": "proof_of_purchase",
        "description": "<string>"
      }
    ],
    "riskFlags": [
      {
        "code": "evidence_inconsistent"
      }
    ],
    "suggestedNextStep": {
      "code": "request_proof_of_purchase",
      "explanation": "<string>"
    },
    "confidence": 0.5
  }
}