docs.vin

warranty

The warranty noun — identity, lifecycle, events, and every capability as an anchored section: 9 capabilities, 0 live, 9 sandbox, 0 declared.

warranty is one of the estate's 317 automotive nouns — a job a car needs done. It carries 9 capabilities: 0 live, 9 sandbox, 0 declared · doors warranties.vin · aggregator.vin.

Identity

Nounwarranty
PillarData (facets: 5 data · 3 services · 1 commerce)
Capabilities9 — 0 live · 9 sandbox · 0 declared
EntitiesProtectionProduct
Doorsaggregator.vin · warranties.vin
SDKVin.warranty.* from apis.vin
Address/catalog/warranty#{action} — the anchor IS the wire name minus warranty.

Events

The vocabulary this noun can append to the record — 7 past-tense, versioned event types, each linked to the capability that emits it:

Discover & read

lookup

warranty.lookup · GET /warranties/lookup · gate none · sandbox · answers WarrantyLookup@1

FieldTypeRequiredNotes
vinstringno—

Door — warranties.vin serves this noun on its two routes: / (the landing) · /KMHM54AAXPA050499 (the VIN lens).

Try it — sandbox: every call answers a deterministic, provenance-labeled simulated payload ({ environment, simulated } in the body). Force any documented outcome with the magic triggers. Going live is a connect, never a ballot: submit the credential at integrates.vin (dealer systems) or connects.vin (consumer accounts) — submissions enter the activation queue and rank live rollout.

the SDK — warranty.lookup
import { warranty } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await warranty.lookup({"vin":"KMHM54AAXPA050499"})
GET /warranties/lookup
curl 'https://apis.vin/warranties/lookup?vin=KMHM54AAXPA050499'

Receipt — the sandbox wire answered the request above with this exact body at build time. Captured by the receipts runner (timestamped, provenance in the payload), never authored; it re-executes only when this descriptor changes.

receipt · executed 2026-08-17T12:42:18.889Z · HTTP 200
{
  "type": "OK",
  "answers": "WarrantyLookup@1",
  "value": {
    "id": "warranty_4d92a204",
    "dealId": "deal_0ee4cffe",
    "holderId": "party_d8c22e46",
    "product": "product-52c693e0",
    "term": "term-df0e331b",
    "premium": {
      "amount": "1534.26",
      "currency": "USD"
    }
  },
  "evidence": {
    "id": "warranty_4d92a204",
    "dealId": "deal_0ee4cffe",
    "holderId": "party_d8c22e46",
    "product": "product-52c693e0",
    "term": "term-df0e331b",
    "premium": {
      "amount": "1534.26",
      "currency": "USD"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "warranty-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

mileageVerify

warranty.mileageVerify · GET /warranties/mileage-verify · gate none · sandbox · answers WarrantyMileageVerify@1

No input — this capability takes no request body.

Door — aggregator.vin serves this noun on its two routes: / (the landing) · /KMHM54AAXPA050499 (the VIN lens).

Try it — sandbox: every call answers a deterministic, provenance-labeled simulated payload ({ environment, simulated } in the body). Force any documented outcome with the magic triggers. Going live is a connect, never a ballot: submit the credential at integrates.vin (dealer systems) or connects.vin (consumer accounts) — submissions enter the activation queue and rank live rollout.

the SDK — warranty.mileageVerify
import { warranty } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await warranty.mileageVerify()
GET /warranties/mileage-verify
curl 'https://apis.vin/warranties/mileage-verify'

Receipt — the sandbox wire answered the request above with this exact body at build time. Captured by the receipts runner (timestamped, provenance in the payload), never authored; it re-executes only when this descriptor changes.

receipt · executed 2026-08-16T14:50:10.088Z · HTTP 200
{
  "type": "OK",
  "answers": "WarrantyMileageVerify@1",
  "value": {
    "id": "warranty_d4e3d68e",
    "dealId": "deal_f32ac338",
    "holderId": "party_405f6bc0",
    "product": "product-89d7987a",
    "term": "term-0ab5ccf1",
    "premium": {
      "amount": "2787.10",
      "currency": "USD"
    }
  },
  "evidence": {
    "id": "warranty_d4e3d68e",
    "dealId": "deal_f32ac338",
    "holderId": "party_405f6bc0",
    "product": "product-89d7987a",
    "term": "term-0ab5ccf1",
    "premium": {
      "amount": "2787.10",
      "currency": "USD"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "warranty-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

Pay & settle

claimPay

warranty.claimPay · POST /warranties/claim-pay · gate offer · sandbox · answers WarrantyClaimPay@1

FieldTypeRequiredNotes
vinstringno—

The gate is a 402 OFFER — the price and a hard ceiling on the wire, with a durable intent that executes on settlement. Never a wall, never "contact sales". Price: not posted — see /pricing.

Door — warranties.vin serves this noun on its two routes: / (the landing) · /KMHM54AAXPA050499 (the VIN lens).

Try it — sandbox: every call answers a deterministic, provenance-labeled simulated payload ({ environment, simulated } in the body). Force any documented outcome with the magic triggers. Going live is a connect, never a ballot: submit the credential at integrates.vin (dealer systems) or connects.vin (consumer accounts) — submissions enter the activation queue and rank live rollout.

Emits — Warranty.claimPaid@1 · Warranty.failed@1.

the SDK — warranty.claimPay
import { warranty } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await warranty.claimPay({"vin":"KMHM54AAXPA050499"})
POST /warranties/claim-pay
curl -X POST https://apis.vin/warranties/claim-pay \
  -H 'content-type: application/json' \
  -d '{"vin":"KMHM54AAXPA050499"}'

Receipt — the sandbox wire answered the request above with this exact body at build time. Captured by the receipts runner (timestamped, provenance in the payload), never authored; it re-executes only when this descriptor changes.

receipt · executed 2026-08-17T12:42:18.868Z · HTTP 200
{
  "type": "OK",
  "answers": "WarrantyClaimPay@1",
  "value": {
    "id": "warranty_9df8fe95",
    "vin": "vin-df609d05",
    "claimType": "option-3",
    "repairOrderId": "repairorder_6563c812",
    "laborOps": [],
    "status": "WarrantyClaim-01"
  },
  "evidence": {
    "id": "warranty_9df8fe95",
    "vin": "vin-df609d05",
    "claimType": "option-3",
    "repairOrderId": "repairorder_6563c812",
    "laborOps": [],
    "status": "WarrantyClaim-01"
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "warranty-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

Fulfill & operate

expiryRemind

warranty.expiryRemind · POST /warranties/expiry-remind · gate key · sandbox · answers WarrantyExpiryRemind@1

No input — this capability takes no request body.

Door — aggregator.vin serves this noun on its two routes: / (the landing) · /KMHM54AAXPA050499 (the VIN lens).

Try it — sandbox: every call answers a deterministic, provenance-labeled simulated payload ({ environment, simulated } in the body). Force any documented outcome with the magic triggers. Going live is a connect, never a ballot: submit the credential at integrates.vin (dealer systems) or connects.vin (consumer accounts) — submissions enter the activation queue and rank live rollout.

Emits — Warranty.expiryReminded@1.

the SDK — warranty.expiryRemind
import { warranty } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await warranty.expiryRemind()
POST /warranties/expiry-remind
curl -X POST https://apis.vin/warranties/expiry-remind \
  -H 'content-type: application/json' \
  -d '{}'

Receipt — the sandbox wire answered the request above with this exact body at build time. Captured by the receipts runner (timestamped, provenance in the payload), never authored; it re-executes only when this descriptor changes.

receipt · executed 2026-08-16T14:50:10.088Z · HTTP 200
{
  "type": "OK",
  "answers": "WarrantyExpiryRemind@1",
  "value": {
    "id": "warranty_0d2ae142",
    "dealId": "deal_74e75104",
    "holderId": "party_551015b4",
    "product": "product-8b227f5e",
    "term": "term-c99bca15",
    "premium": {
      "amount": "2324.03",
      "currency": "USD"
    }
  },
  "evidence": {
    "id": "warranty_0d2ae142",
    "dealId": "deal_74e75104",
    "holderId": "party_551015b4",
    "product": "product-8b227f5e",
    "term": "term-c99bca15",
    "premium": {
      "amount": "2324.03",
      "currency": "USD"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "warranty-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

Authorize & resolve

claim

warranty.claim · POST /warranties/claim · gate offer · sandbox · answers WarrantyClaim@1

FieldTypeRequiredNotes
vinstringyes—
repairOrderIdstringyes—
claimTypestringnoone of factory, recall, vsc
laborOpsarray<object>no—
authoritystringno—

The gate is a 402 OFFER — the price and a hard ceiling on the wire, with a durable intent that executes on settlement. Never a wall, never "contact sales". Price: not posted — see /pricing.

Delegated calls require a typed Mandate — { ceiling, perAction, expires, tripwires }; the ceiling is a field, not a conversation.

Door — warranties.vin serves this noun on its two routes: / (the landing) · /KMHM54AAXPA050499 (the VIN lens).

Try it — sandbox: every call answers a deterministic, provenance-labeled simulated payload ({ environment, simulated } in the body). Force any documented outcome with the magic triggers. Going live is a connect, never a ballot: submit the credential at integrates.vin (dealer systems) or connects.vin (consumer accounts) — submissions enter the activation queue and rank live rollout.

Emits — WarrantyClaim.filed@1 · WarrantyClaim.approved@1 · WarrantyClaim.reimbursed@1.

the SDK — warranty.claim
import { warranty } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await warranty.claim({"vin":"KMHM54AAXPA050499","repairOrderId":"repairorderid"})
POST /warranties/claim
curl -X POST https://apis.vin/warranties/claim \
  -H 'content-type: application/json' \
  -d '{"vin":"KMHM54AAXPA050499","repairOrderId":"repairorderid"}'

Receipt — the sandbox wire answered the request above with this exact body at build time. Captured by the receipts runner (timestamped, provenance in the payload), never authored; it re-executes only when this descriptor changes.

receipt · executed 2026-08-17T12:42:18.868Z · HTTP 200
{
  "type": "OK",
  "answers": "WarrantyClaim@1",
  "value": {
    "id": "warranty_9c78c730",
    "vin": "vin-0f695c9a",
    "claimType": "option-3",
    "repairOrderId": "repairorder_b5a73351",
    "laborOps": [],
    "status": "WarrantyClaim-01"
  },
  "evidence": {
    "id": "warranty_9c78c730",
    "vin": "vin-0f695c9a",
    "claimType": "option-3",
    "repairOrderId": "repairorder_b5a73351",
    "laborOps": [],
    "status": "WarrantyClaim-01"
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "warranty-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

Lifecycle & state

transfer

warranty.transfer · POST /warranties/transfer · gate offer · sandbox · answers WarrantyTransfer@1

FieldTypeRequiredNotes
vinstringno—

The gate is a 402 OFFER — the price and a hard ceiling on the wire, with a durable intent that executes on settlement. Never a wall, never "contact sales". Price: not posted — see /pricing.

Door — warranties.vin serves this noun on its two routes: / (the landing) · /KMHM54AAXPA050499 (the VIN lens).

Try it — sandbox: every call answers a deterministic, provenance-labeled simulated payload ({ environment, simulated } in the body). Force any documented outcome with the magic triggers. Going live is a connect, never a ballot: submit the credential at integrates.vin (dealer systems) or connects.vin (consumer accounts) — submissions enter the activation queue and rank live rollout.

Emits — Warranty.transferred@1.

the SDK — warranty.transfer
import { warranty } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await warranty.transfer({"vin":"KMHM54AAXPA050499"})
POST /warranties/transfer
curl -X POST https://apis.vin/warranties/transfer \
  -H 'content-type: application/json' \
  -d '{"vin":"KMHM54AAXPA050499"}'

Receipt — the sandbox wire answered the request above with this exact body at build time. Captured by the receipts runner (timestamped, provenance in the payload), never authored; it re-executes only when this descriptor changes.

receipt · executed 2026-08-17T12:42:18.899Z · HTTP 200
{
  "type": "OK",
  "answers": "WarrantyTransfer@1",
  "value": {
    "id": "warranty_3575a7e0",
    "dealId": "deal_dace40e2",
    "holderId": "party_e162b6e2",
    "product": "product-54d8b82c",
    "term": "term-92fe23d7",
    "premium": {
      "amount": "810.17",
      "currency": "USD"
    }
  },
  "evidence": {
    "id": "warranty_3575a7e0",
    "dealId": "deal_dace40e2",
    "holderId": "party_e162b6e2",
    "product": "product-54d8b82c",
    "term": "term-92fe23d7",
    "premium": {
      "amount": "810.17",
      "currency": "USD"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "warranty-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

More actions

cpo

warranty.cpo · GET /warranties/cpo · gate key · sandbox · answers WarrantyCpo@1

FieldTypeRequiredNotes
vinstringno—

Door — warranties.vin serves this noun on its two routes: / (the landing) · /KMHM54AAXPA050499 (the VIN lens).

Try it — sandbox: every call answers a deterministic, provenance-labeled simulated payload ({ environment, simulated } in the body). Force any documented outcome with the magic triggers. Going live is a connect, never a ballot: submit the credential at integrates.vin (dealer systems) or connects.vin (consumer accounts) — submissions enter the activation queue and rank live rollout.

the SDK — warranty.cpo
import { warranty } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await warranty.cpo({"vin":"KMHM54AAXPA050499"})
GET /warranties/cpo
curl 'https://apis.vin/warranties/cpo?vin=KMHM54AAXPA050499'

Receipt — the sandbox wire answered the request above with this exact body at build time. Captured by the receipts runner (timestamped, provenance in the payload), never authored; it re-executes only when this descriptor changes.

receipt · executed 2026-08-17T12:42:18.882Z · HTTP 200
{
  "type": "OK",
  "answers": "WarrantyCpo@1",
  "value": {
    "id": "warranty_a168b0f2",
    "dealId": "deal_f18882b4",
    "holderId": "party_2b725a04",
    "product": "product-737436ee",
    "term": "term-2c2c59c5",
    "premium": {
      "amount": "241.94",
      "currency": "USD"
    }
  },
  "evidence": {
    "id": "warranty_a168b0f2",
    "dealId": "deal_f18882b4",
    "holderId": "party_2b725a04",
    "product": "product-737436ee",
    "term": "term-2c2c59c5",
    "premium": {
      "amount": "241.94",
      "currency": "USD"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "warranty-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

recall

warranty.recall · GET /warranties/recall · gate none · sandbox · answers WarrantyRecall@1

FieldTypeRequiredNotes
vinstringno—

Door — warranties.vin serves this noun on its two routes: / (the landing) · /KMHM54AAXPA050499 (the VIN lens).

Try it — sandbox: every call answers a deterministic, provenance-labeled simulated payload ({ environment, simulated } in the body). Force any documented outcome with the magic triggers. Going live is a connect, never a ballot: submit the credential at integrates.vin (dealer systems) or connects.vin (consumer accounts) — submissions enter the activation queue and rank live rollout.

the SDK — warranty.recall
import { warranty } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await warranty.recall({"vin":"KMHM54AAXPA050499"})
GET /warranties/recall
curl 'https://apis.vin/warranties/recall?vin=KMHM54AAXPA050499'

Receipt — the sandbox wire answered the request above with this exact body at build time. Captured by the receipts runner (timestamped, provenance in the payload), never authored; it re-executes only when this descriptor changes.

receipt · executed 2026-08-17T12:42:18.889Z · HTTP 200
{
  "type": "OK",
  "answers": "WarrantyRecall@1",
  "value": {
    "id": "warranty_54a136c0",
    "dealId": "deal_b6dadb82",
    "holderId": "party_c581f882",
    "product": "product-c879ca8c",
    "term": "term-3c517cb7",
    "premium": {
      "amount": "3420.75",
      "currency": "USD"
    }
  },
  "evidence": {
    "id": "warranty_54a136c0",
    "dealId": "deal_b6dadb82",
    "holderId": "party_c581f882",
    "product": "product-c879ca8c",
    "term": "term-3c517cb7",
    "premium": {
      "amount": "3420.75",
      "currency": "USD"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "warranty-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

remaining

warranty.remaining · GET /warranties/remaining · gate key · sandbox · answers WarrantyRemaining@1

FieldTypeRequiredNotes
vinstringno—

Door — warranties.vin serves this noun on its two routes: / (the landing) · /KMHM54AAXPA050499 (the VIN lens).

Try it — sandbox: every call answers a deterministic, provenance-labeled simulated payload ({ environment, simulated } in the body). Force any documented outcome with the magic triggers. Going live is a connect, never a ballot: submit the credential at integrates.vin (dealer systems) or connects.vin (consumer accounts) — submissions enter the activation queue and rank live rollout.

the SDK — warranty.remaining
import { warranty } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await warranty.remaining({"vin":"KMHM54AAXPA050499"})
GET /warranties/remaining
curl 'https://apis.vin/warranties/remaining?vin=KMHM54AAXPA050499'

Receipt — the sandbox wire answered the request above with this exact body at build time. Captured by the receipts runner (timestamped, provenance in the payload), never authored; it re-executes only when this descriptor changes.

receipt · executed 2026-08-17T12:42:18.891Z · HTTP 200
{
  "type": "OK",
  "answers": "WarrantyRemaining@1",
  "value": {
    "vin": "KMHM54AAXPA050499",
    "mileage": 45000,
    "powertrainMilesLeft": 15000,
    "bumperMilesLeft": 0,
    "transferable": true
  },
  "evidence": {
    "vin": "KMHM54AAXPA050499",
    "mileage": 45000,
    "powertrainMilesLeft": 15000,
    "bumperMilesLeft": 0,
    "transferable": true
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "services-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

Data model

The record shape behind this noun — one entity, each property an evidence field. See the whole estate model on the data model page.

ProtectionProduct

Modeled

The noun drawn out — its record shape, its lifecycle, and how it is exercised end to end. 2 diagrams, rendered from the estate model.

Warranty · Class model

Warranty · Sequence

Generated from the catalog. Every capability, answer, gate, and entity on this page is a rendered descriptor — it cannot drift from the wire.

vindex

The vindex noun — identity, lifecycle, events, and every capability as an anchored section: 1 capability, 0 live, 1 sandbox, 0 declared.

wheels

The wheels noun — identity, lifecycle, events, and every capability as an anchored section: 16 capabilities, 1 live, 15 sandbox, 0 declared.

On this page

Identity
Events
Discover & read
lookup
mileageVerify
Pay & settle
claimPay
Fulfill & operate
expiryRemind
Authorize & resolve
claim
Lifecycle & state
transfer
More actions
cpo
recall
remaining
Data model
ProtectionProduct
Modeled