roadside

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

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

Identity


Noun	`roadside`
Pillar	Services (facets: 5 data · 8 services · 5 commerce)
Capabilities	18 — 0 live · 18 sandbox · 0 declared
Entities	`Tow`
Doors	`roadside.vin`
SDK	`Vin.roadside.*` from `apis.vin`
Address	`/catalog/roadside#{action}` — the anchor IS the wire name minus `roadside.`

Events

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

Roadside.arrived@1 — emitted by dispatch
Roadside.claimFailed@1 — emitted by claim
Roadside.claimRequested@1 — emitted by claim
Roadside.claimed@1 — emitted by claim
Roadside.completed@1 — emitted by dispatch
Roadside.dispatchFailed@1 — emitted by dispatch
Roadside.dispatchRequested@1 — emitted by dispatch
Roadside.dispatched@1 — emitted by dispatch
Roadside.etaUpdated@1 — emitted by eta
Roadside.fuelDelivered@1 — emitted by fuelDelivery
Roadside.fuelDeliveryRequested@1 — emitted by fuelDelivery
Roadside.jumpstartRequested@1 — emitted by jumpstart
Roadside.jumpstarted@1 — emitted by jumpstart
Roadside.lockoutRequested@1 — emitted by lockout
Roadside.lockouted@1 — emitted by lockout
Roadside.paid@1 — emitted by pay
Roadside.payFailed@1 — emitted by pay
Roadside.payRequested@1 — emitted by pay
Roadside.quoteRequested@1 — emitted by quote
Roadside.quoted@1 — emitted by quote
Roadside.reimburseRequested@1 — emitted by reimburse
Roadside.reimbursed@1 — emitted by reimburse
Roadside.requestRequested@1 — emitted by request
Roadside.requested@1 — emitted by request
Roadside.subscribeRequested@1 — emitted by subscribe
Roadside.subscribed@1 — emitted by subscribe
Roadside.tireChangeRequested@1 — emitted by tireChange
Roadside.tireChanged@1 — emitted by tireChange
Roadside.towTriggerRequested@1 — emitted by towTrigger
Roadside.towTriggered@1 — emitted by towTrigger
Roadside.winchFailed@1 — emitted by winch
Roadside.winchRequested@1 — emitted by winch
Roadside.winched@1 — emitted by winch
ServiceOrder.settled@1 — emitted by dispatch

Discover & read

history

roadside.history · GET /roadsides/history · gate none · sandbox · answers RoadsideHistory@1

Field	Type	Required	Notes
`vin`	`string`	no	—

Door — roadside.vin serves this noun on its two routes: / (the landing) · /KM8R44HE7LU170741 (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 — roadside.history

import { roadside } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await roadside.history({"vin":"KM8R44HE7LU170741"})

GET /roadsides/history

curl 'https://apis.vin/roadsides/history?vin=KM8R44HE7LU170741'

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:16.845Z · HTTP 200

{
  "type": "OK",
  "answers": "RoadsideHistory@1",
  "value": {
    "vin": "KM8R44HE7LU170741",
    "noun": "roadside",
    "asOf": "2026-08-10",
    "events": [
      {
        "date": "2024-03-14",
        "kind": "routine",
        "description": "routine roadside assistance record"
      }
    ]
  },
  "evidence": {
    "vin": "KM8R44HE7LU170741",
    "noun": "roadside",
    "asOf": "2026-08-10",
    "events": [
      {
        "date": "2024-03-14",
        "kind": "routine",
        "description": "routine roadside assistance record"
      }
    ]
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "compliance-keys-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

status

roadside.status · GET /roadsides/status · gate none · sandbox · answers RoadsideStatus@1

Field	Type	Required	Notes
`vin`	`string`	no	—

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

the SDK — roadside.status

import { roadside } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await roadside.status({"vin":"KM8R44HE7LU170741"})

GET /roadsides/status

curl 'https://apis.vin/roadsides/status?vin=KM8R44HE7LU170741'

receipt · executed 2026-08-17T12:42:16.884Z · HTTP 200

{
  "type": "OK",
  "answers": "RoadsideStatus@1",
  "value": {
    "vin": "KM8R44HE7LU170741",
    "noun": "roadside",
    "asOf": "2026-08-10",
    "dispatch": {
      "status": "no-active-dispatch"
    }
  },
  "evidence": {
    "vin": "KM8R44HE7LU170741",
    "noun": "roadside",
    "asOf": "2026-08-10",
    "dispatch": {
      "status": "no-active-dispatch"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "compliance-keys-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

locate

roadside.locate · GET /roadsides/locate · gate none · sandbox · answers RoadsideLocate@1

Field	Type	Required	Notes
`vin`	`string`	no	—

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

the SDK — roadside.locate

import { roadside } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await roadside.locate({"vin":"KM8R44HE7LU170741"})

GET /roadsides/locate

curl 'https://apis.vin/roadsides/locate?vin=KM8R44HE7LU170741'

receipt · executed 2026-08-17T12:42:16.852Z · HTTP 200

{
  "type": "OK",
  "answers": "RoadsideLocate@1",
  "value": {
    "vin": "KM8R44HE7LU170741",
    "noun": "roadside",
    "asOf": "2026-08-10",
    "location": {
      "method": "telematics",
      "current": true,
      "mileMarker": 15
    }
  },
  "evidence": {
    "vin": "KM8R44HE7LU170741",
    "noun": "roadside",
    "asOf": "2026-08-10",
    "location": {
      "method": "telematics",
      "current": true,
      "mileMarker": 15
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "compliance-keys-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

eta

roadside.eta · GET /roadsides/eta · gate key · sandbox · answers RoadsideEta@1

Field	Type	Required	Notes
`vin`	`string`	no	—

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

Emits — Roadside.etaUpdated@1.

the SDK — roadside.eta

import { roadside } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await roadside.eta({"vin":"KM8R44HE7LU170741"})

GET /roadsides/eta

curl 'https://apis.vin/roadsides/eta?vin=KM8R44HE7LU170741'

receipt · executed 2026-08-17T12:42:16.845Z · HTTP 200

{
  "type": "OK",
  "answers": "RoadsideEta@1",
  "value": {
    "vin": "KM8R44HE7LU170741",
    "noun": "roadside",
    "asOf": "2026-08-10",
    "eta": {
      "status": "no-active-dispatch"
    }
  },
  "evidence": {
    "vin": "KM8R44HE7LU170741",
    "noun": "roadside",
    "asOf": "2026-08-10",
    "eta": {
      "status": "no-active-dispatch"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "compliance-keys-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

coverageCheck

roadside.coverageCheck · GET /roadsides/coverage-check · gate none · sandbox · answers RoadsideCoverageCheck@1

Field	Type	Required	Notes
`vin`	`string`	no	—

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

the SDK — roadside.coverageCheck

import { roadside } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await roadside.coverageCheck({"vin":"KM8R44HE7LU170741"})

GET /roadsides/coverage-check

curl 'https://apis.vin/roadsides/coverage-check?vin=KM8R44HE7LU170741'

receipt · executed 2026-08-17T12:42:16.845Z · HTTP 200

{
  "type": "OK",
  "answers": "RoadsideCoverageCheck@1",
  "value": {
    "vin": "KM8R44HE7LU170741",
    "covered": true,
    "plan": "premium",
    "towMilesIncluded": 100,
    "jumpstartIncluded": true,
    "lockoutIncluded": true,
    "termMonthsRemaining": 9
  },
  "evidence": {
    "vin": "KM8R44HE7LU170741",
    "covered": true,
    "plan": "premium",
    "towMilesIncluded": 100,
    "jumpstartIncluded": true,
    "lockoutIncluded": true,
    "termMonthsRemaining": 9
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "services-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

Quote & price

quote

roadside.quote · POST /roadsides/quote · gate offer · sandbox · answers RoadsideQuote@1

Field	Type	Required	Notes
`vin`	`string`	no	—

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 — roadside.vin serves this noun on its two routes: / (the landing) · /KM8R44HE7LU170741 (the VIN lens).

Emits — Roadside.quoteRequested@1 · Roadside.quoted@1.

the SDK — roadside.quote

import { roadside } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await roadside.quote({"vin":"KM8R44HE7LU170741"})

POST /roadsides/quote

curl -X POST https://apis.vin/roadsides/quote \
  -H 'content-type: application/json' \
  -d '{"vin":"KM8R44HE7LU170741"}'

receipt · executed 2026-08-17T12:42:16.860Z · HTTP 200

{
  "type": "OK",
  "answers": "RoadsideQuote@1",
  "value": {
    "vin": "KM8R44HE7LU170741",
    "noun": "roadside",
    "asOf": "2026-08-10",
    "quote": {
      "id": "RQ-bd222c35",
      "services": {
        "tow": 12500,
        "jumpstart": 7500,
        "lockout": 7500,
        "fuelDelivery": 7500,
        "tireChange": 7500
      },
      "currency": "USD",
      "status": "extended"
    }
  },
  "evidence": {
    "vin": "KM8R44HE7LU170741",
    "noun": "roadside",
    "asOf": "2026-08-10",
    "quote": {
      "id": "RQ-bd222c35",
      "services": {
        "tow": 12500,
        "jumpstart": 7500,
        "lockout": 7500,
        "fuelDelivery": 7500,
        "tireChange": 7500
      },
      "currency": "USD",
      "status": "extended"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "compliance-keys-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

Apply & book

request

roadside.request · POST /roadsides/request · gate offer · sandbox · answers RoadsideRequest@1

Field	Type	Required	Notes
`vin`	`string`	no	—

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 — roadside.vin serves this noun on its two routes: / (the landing) · /KM8R44HE7LU170741 (the VIN lens).

Emits — Roadside.requestRequested@1 · Roadside.requested@1.

the SDK — roadside.request

import { roadside } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await roadside.request({"vin":"KM8R44HE7LU170741"})

POST /roadsides/request

curl -X POST https://apis.vin/roadsides/request \
  -H 'content-type: application/json' \
  -d '{"vin":"KM8R44HE7LU170741"}'

receipt · executed 2026-08-17T12:42:16.880Z · HTTP 200

{
  "type": "OK",
  "answers": "RoadsideRequest@1",
  "value": {
    "vin": "KM8R44HE7LU170741",
    "noun": "roadside",
    "asOf": "2026-08-10",
    "request": {
      "id": "RSR-f090972c",
      "status": "assistance-requested"
    }
  },
  "evidence": {
    "vin": "KM8R44HE7LU170741",
    "noun": "roadside",
    "asOf": "2026-08-10",
    "request": {
      "id": "RSR-f090972c",
      "status": "assistance-requested"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "compliance-keys-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

roadside.subscribe · POST /roadsides/subscribe · gate offer · sandbox · answers RoadsideSubscribe@1

Field	Type	Required	Notes
`vin`	`string`	no	—

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 — roadside.vin serves this noun on its two routes: / (the landing) · /KM8R44HE7LU170741 (the VIN lens).

Emits — Roadside.subscribeRequested@1 · Roadside.subscribed@1.

the SDK — roadside.subscribe

import { roadside } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await roadside.subscribe({"vin":"KM8R44HE7LU170741"})

POST /roadsides/subscribe

curl -X POST https://apis.vin/roadsides/subscribe \
  -H 'content-type: application/json' \
  -d '{"vin":"KM8R44HE7LU170741"}'

receipt · executed 2026-08-17T12:42:16.884Z · HTTP 200

{
  "type": "OK",
  "answers": "RoadsideSubscribe@1",
  "value": {
    "vin": "KM8R44HE7LU170741",
    "noun": "roadside",
    "asOf": "2026-08-10",
    "membership": {
      "id": "RSM-70eaea23",
      "status": "active",
      "annualCents": 9900,
      "currency": "USD"
    },
    "payer": {
      "name": "Ava Good",
      "castRow": "super-prime",
      "creditTier": "super-prime"
    }
  },
  "evidence": {
    "vin": "KM8R44HE7LU170741",
    "noun": "roadside",
    "asOf": "2026-08-10",
    "membership": {
      "id": "RSM-70eaea23",
      "status": "active",
      "annualCents": 9900,
      "currency": "USD"
    },
    "payer": {
      "name": "Ava Good",
      "castRow": "super-prime",
      "creditTier": "super-prime"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "compliance-keys-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

dispatch

roadside.dispatch · POST /roadsides/dispatch · gate offer · sandbox · answers RoadsideDispatch@1

Field	Type	Required	Notes
`vin`	`string`	yes	—
`incident`	`string`	yes	one of `tow`, `lockout`, `jumpstart`, `fuel`, `tire-change`, `winch`
`location`	`object`	yes	—
`membership`	`string`	no	—
`authority`	`string`	no	—

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 — roadside.vin serves this noun on its two routes: / (the landing) · /KM8R44HE7LU170741 (the VIN lens).

Emits — Roadside.arrived@1 · Roadside.completed@1 · Roadside.dispatchFailed@1 · Roadside.dispatchRequested@1 · Roadside.dispatched@1 · ServiceOrder.settled@1.

the SDK — roadside.dispatch

import { roadside } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await roadside.dispatch({"vin":"KM8R44HE7LU170741","incident":"tow","location":{}})

POST /roadsides/dispatch

curl -X POST https://apis.vin/roadsides/dispatch \
  -H 'content-type: application/json' \
  -d '{"vin":"KM8R44HE7LU170741","incident":"tow","location":{}}'

receipt · executed 2026-08-17T12:42:16.845Z · HTTP 200

{
  "type": "OK",
  "answers": "RoadsideDispatch@1",
  "value": {
    "vin": "KM8R44HE7LU170741",
    "orderId": "serviceorder_EMVh3MmY1dFQ",
    "serviceType": "repair",
    "dispatched": true,
    "status": "Dispatched",
    "etaMinDays": 1,
    "etaMaxDays": 5
  },
  "evidence": {
    "vin": "KM8R44HE7LU170741",
    "orderId": "serviceorder_EMVh3MmY1dFQ",
    "serviceType": "repair",
    "dispatched": true,
    "status": "Dispatched",
    "etaMinDays": 1,
    "etaMaxDays": 5
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "field-services-rail-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

Pay & settle

pay

roadside.pay · POST /roadsides/pay · gate offer · sandbox · answers RoadsidePay@1

Field	Type	Required	Notes
`vin`	`string`	no	—

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 — roadside.vin serves this noun on its two routes: / (the landing) · /KM8R44HE7LU170741 (the VIN lens).

Emits — Roadside.paid@1 · Roadside.payFailed@1 · Roadside.payRequested@1.

the SDK — roadside.pay

import { roadside } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await roadside.pay({"vin":"KM8R44HE7LU170741"})

POST /roadsides/pay

curl -X POST https://apis.vin/roadsides/pay \
  -H 'content-type: application/json' \
  -d '{"vin":"KM8R44HE7LU170741"}'

receipt · executed 2026-08-17T12:42:16.860Z · HTTP 200

{
  "type": "OK",
  "answers": "RoadsidePay@1",
  "value": {
    "vin": "KM8R44HE7LU170741",
    "noun": "roadside",
    "asOf": "2026-08-10",
    "payment": {
      "id": "PAY-88dbcea3",
      "status": "settled",
      "amountCents": 7500,
      "currency": "USD"
    },
    "payer": {
      "name": "Ava Good",
      "castRow": "super-prime",
      "creditTier": "super-prime"
    }
  },
  "evidence": {
    "vin": "KM8R44HE7LU170741",
    "noun": "roadside",
    "asOf": "2026-08-10",
    "payment": {
      "id": "PAY-88dbcea3",
      "status": "settled",
      "amountCents": 7500,
      "currency": "USD"
    },
    "payer": {
      "name": "Ava Good",
      "castRow": "super-prime",
      "creditTier": "super-prime"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "compliance-keys-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

reimburse

roadside.reimburse · POST /roadsides/reimburse · gate offer · sandbox · answers RoadsideReimburse@1

Field	Type	Required	Notes
`vin`	`string`	no	—

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 — roadside.vin serves this noun on its two routes: / (the landing) · /KM8R44HE7LU170741 (the VIN lens).

Emits — Roadside.reimburseRequested@1 · Roadside.reimbursed@1.

the SDK — roadside.reimburse

import { roadside } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await roadside.reimburse({"vin":"KM8R44HE7LU170741"})

POST /roadsides/reimburse

curl -X POST https://apis.vin/roadsides/reimburse \
  -H 'content-type: application/json' \
  -d '{"vin":"KM8R44HE7LU170741"}'

receipt · executed 2026-08-17T12:42:16.870Z · HTTP 200

{
  "type": "OK",
  "answers": "RoadsideReimburse@1",
  "value": {
    "vin": "KM8R44HE7LU170741",
    "noun": "roadside",
    "asOf": "2026-08-10",
    "reimbursement": {
      "status": "no-claim-on-file"
    }
  },
  "evidence": {
    "vin": "KM8R44HE7LU170741",
    "noun": "roadside",
    "asOf": "2026-08-10",
    "reimbursement": {
      "status": "no-claim-on-file"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "compliance-keys-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

Authorize & resolve

claim

roadside.claim · POST /roadsides/claim · gate offer · sandbox · answers RoadsideClaim@1

Field	Type	Required	Notes
`vin`	`string`	no	—

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 — roadside.vin serves this noun on its two routes: / (the landing) · /KM8R44HE7LU170741 (the VIN lens).

Emits — Roadside.claimFailed@1 · Roadside.claimRequested@1 · Roadside.claimed@1.

the SDK — roadside.claim

import { roadside } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await roadside.claim({"vin":"KM8R44HE7LU170741"})

POST /roadsides/claim

curl -X POST https://apis.vin/roadsides/claim \
  -H 'content-type: application/json' \
  -d '{"vin":"KM8R44HE7LU170741"}'

receipt · executed 2026-08-17T12:42:16.845Z · HTTP 200

{
  "type": "OK",
  "answers": "RoadsideClaim@1",
  "value": {
    "vin": "KM8R44HE7LU170741",
    "noun": "roadside",
    "asOf": "2026-08-10",
    "claim": {
      "id": "CLM-39670c10",
      "status": "claim-filed"
    }
  },
  "evidence": {
    "vin": "KM8R44HE7LU170741",
    "noun": "roadside",
    "asOf": "2026-08-10",
    "claim": {
      "id": "CLM-39670c10",
      "status": "claim-filed"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "compliance-keys-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

More actions

fuelDelivery

roadside.fuelDelivery · POST /roadsides/fuel-delivery · gate offer · sandbox · answers RoadsideFuelDelivery@1

Field	Type	Required	Notes
`vin`	`string`	no	—

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 — roadside.vin serves this noun on its two routes: / (the landing) · /KM8R44HE7LU170741 (the VIN lens).

Emits — Roadside.fuelDelivered@1 · Roadside.fuelDeliveryRequested@1.

the SDK — roadside.fuelDelivery

import { roadside } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await roadside.fuelDelivery({"vin":"KM8R44HE7LU170741"})

POST /roadsides/fuel-delivery

curl -X POST https://apis.vin/roadsides/fuel-delivery \
  -H 'content-type: application/json' \
  -d '{"vin":"KM8R44HE7LU170741"}'

receipt · executed 2026-08-17T12:42:16.845Z · HTTP 200

{
  "type": "OK",
  "answers": "RoadsideFuelDelivery@1",
  "value": {
    "vin": "KM8R44HE7LU170741",
    "noun": "roadside",
    "asOf": "2026-08-10",
    "service": {
      "status": "fuel-delivered",
      "gallons": 2,
      "amountCents": 7500,
      "currency": "USD"
    }
  },
  "evidence": {
    "vin": "KM8R44HE7LU170741",
    "noun": "roadside",
    "asOf": "2026-08-10",
    "service": {
      "status": "fuel-delivered",
      "gallons": 2,
      "amountCents": 7500,
      "currency": "USD"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "compliance-keys-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

jumpstart

roadside.jumpstart · POST /roadsides/jumpstart · gate offer · sandbox · answers RoadsideJumpstart@1

Field	Type	Required	Notes
`vin`	`string`	no	—

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 — roadside.vin serves this noun on its two routes: / (the landing) · /KM8R44HE7LU170741 (the VIN lens).

Emits — Roadside.jumpstartRequested@1 · Roadside.jumpstarted@1.

the SDK — roadside.jumpstart

import { roadside } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await roadside.jumpstart({"vin":"KM8R44HE7LU170741"})

POST /roadsides/jumpstart

curl -X POST https://apis.vin/roadsides/jumpstart \
  -H 'content-type: application/json' \
  -d '{"vin":"KM8R44HE7LU170741"}'

receipt · executed 2026-08-17T12:42:16.852Z · HTTP 200

{
  "type": "OK",
  "answers": "RoadsideJumpstart@1",
  "value": {
    "vin": "KM8R44HE7LU170741",
    "noun": "roadside",
    "asOf": "2026-08-10",
    "service": {
      "status": "started",
      "verdict": "pass"
    }
  },
  "evidence": {
    "vin": "KM8R44HE7LU170741",
    "noun": "roadside",
    "asOf": "2026-08-10",
    "service": {
      "status": "started",
      "verdict": "pass"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "compliance-keys-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

lockout

roadside.lockout · POST /roadsides/lockout · gate offer · sandbox · answers RoadsideLockout@1

Field	Type	Required	Notes
`vin`	`string`	no	—

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 — roadside.vin serves this noun on its two routes: / (the landing) · /KM8R44HE7LU170741 (the VIN lens).

Emits — Roadside.lockoutRequested@1 · Roadside.lockouted@1.

the SDK — roadside.lockout

import { roadside } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await roadside.lockout({"vin":"KM8R44HE7LU170741"})

POST /roadsides/lockout

curl -X POST https://apis.vin/roadsides/lockout \
  -H 'content-type: application/json' \
  -d '{"vin":"KM8R44HE7LU170741"}'

receipt · executed 2026-08-17T12:42:16.857Z · HTTP 200

{
  "type": "OK",
  "answers": "RoadsideLockout@1",
  "value": {
    "vin": "KM8R44HE7LU170741",
    "noun": "roadside",
    "asOf": "2026-08-10",
    "service": {
      "method": "unlocked-remotely",
      "status": "unlocked"
    }
  },
  "evidence": {
    "vin": "KM8R44HE7LU170741",
    "noun": "roadside",
    "asOf": "2026-08-10",
    "service": {
      "method": "unlocked-remotely",
      "status": "unlocked"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "compliance-keys-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

tireChange

roadside.tireChange · POST /roadsides/tire-change · gate offer · sandbox · answers RoadsideTireChange@1

Field	Type	Required	Notes
`vin`	`string`	no	—

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 — roadside.vin serves this noun on its two routes: / (the landing) · /KM8R44HE7LU170741 (the VIN lens).

Emits — Roadside.tireChangeRequested@1 · Roadside.tireChanged@1.

the SDK — roadside.tireChange

import { roadside } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await roadside.tireChange({"vin":"KM8R44HE7LU170741"})

POST /roadsides/tire-change

curl -X POST https://apis.vin/roadsides/tire-change \
  -H 'content-type: application/json' \
  -d '{"vin":"KM8R44HE7LU170741"}'

receipt · executed 2026-08-17T12:42:16.884Z · HTTP 200

{
  "type": "OK",
  "answers": "RoadsideTireChange@1",
  "value": {
    "vin": "KM8R44HE7LU170741",
    "noun": "roadside",
    "asOf": "2026-08-10",
    "service": {
      "status": "spare-mounted",
      "verdict": "pass"
    }
  },
  "evidence": {
    "vin": "KM8R44HE7LU170741",
    "noun": "roadside",
    "asOf": "2026-08-10",
    "service": {
      "status": "spare-mounted",
      "verdict": "pass"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "compliance-keys-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

towTrigger

roadside.towTrigger · POST /roadsides/tow-trigger · gate offer · sandbox · answers RoadsideTowTrigger@1

Field	Type	Required	Notes
`vin`	`string`	no	—

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 — roadside.vin serves this noun on its two routes: / (the landing) · /KM8R44HE7LU170741 (the VIN lens).

Emits — Roadside.towTriggerRequested@1 · Roadside.towTriggered@1.

the SDK — roadside.towTrigger

import { roadside } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await roadside.towTrigger({"vin":"KM8R44HE7LU170741"})

POST /roadsides/tow-trigger

curl -X POST https://apis.vin/roadsides/tow-trigger \
  -H 'content-type: application/json' \
  -d '{"vin":"KM8R44HE7LU170741"}'

receipt · executed 2026-08-17T12:42:16.886Z · HTTP 200

{
  "type": "OK",
  "answers": "RoadsideTowTrigger@1",
  "value": {
    "vin": "KM8R44HE7LU170741",
    "noun": "roadside",
    "asOf": "2026-08-10",
    "tow": {
      "status": "tow-requested",
      "towId": "TOW-19bb612e"
    }
  },
  "evidence": {
    "vin": "KM8R44HE7LU170741",
    "noun": "roadside",
    "asOf": "2026-08-10",
    "tow": {
      "status": "tow-requested",
      "towId": "TOW-19bb612e"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "compliance-keys-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

winch

roadside.winch · POST /roadsides/winch · gate offer · sandbox · answers RoadsideWinch@1

Field	Type	Required	Notes
`vin`	`string`	no	—

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 — roadside.vin serves this noun on its two routes: / (the landing) · /KM8R44HE7LU170741 (the VIN lens).

Emits — Roadside.winchFailed@1 · Roadside.winchRequested@1 · Roadside.winched@1.

the SDK — roadside.winch

import { roadside } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await roadside.winch({"vin":"KM8R44HE7LU170741"})

POST /roadsides/winch

curl -X POST https://apis.vin/roadsides/winch \
  -H 'content-type: application/json' \
  -d '{"vin":"KM8R44HE7LU170741"}'

receipt · executed 2026-08-17T12:42:16.888Z · HTTP 200

{
  "type": "OK",
  "answers": "RoadsideWinch@1",
  "value": {
    "vin": "KM8R44HE7LU170741",
    "noun": "roadside",
    "asOf": "2026-08-10",
    "service": {
      "status": "recovered"
    }
  },
  "evidence": {
    "vin": "KM8R44HE7LU170741",
    "noun": "roadside",
    "asOf": "2026-08-10",
    "service": {
      "status": "recovered"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "compliance-keys-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

Roadside · State machine

Roadside · Sequence

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

Identity

Events

Discover & read

history

status

locate

eta

coverageCheck

Quote & price

quote

Apply & book

request

dispatch

Pay & settle

pay

reimburse

Authorize & resolve

claim

More actions

fuelDelivery

jumpstart

lockout

tireChange

towTrigger

winch

Data model

Tow

Modeled

On this page