docs.vin

garage

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

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

Identity

Noungarage
PillarData (facets: 1 data · 1 services)
Capabilities2 — 0 live · 2 sandbox · 0 declared
EntitiesVehicle
Doorsaggregator.vin · garage.vin
SDKVin.garage.* from apis.vin
Address/catalog/garage#{action} — the anchor IS the wire name minus garage.

Lifecycle

VehicleKeepLifecycleFSM: 10 states, 13 transitions — Registered · OwnershipVerified · Monitoring · RecallOpen · MaintenanceDue · InService · RegistrationLapsing · InsuranceLapsed · Valued · Disposed. Each transition is a past-tense event on the record.

Events

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

Apply & book

register

garage.register · POST /garages/register · gate key · sandbox · answers GarageVehicle@1

FieldTypeRequiredNotes
vinstringyes
ownerobjectno
nicknamestringno

Doorgarage.vin serves this noun on its two routes: / (the landing) · /1C4PJXEG4SW627021 (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.

EmitsGarage.registered@1 · Vehicle.added@1.

the SDK — garage.register
import { garage } from 'apis.vin'

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

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:12.074Z · HTTP 200
{
  "type": "OK",
  "answers": "GarageVehicle@1",
  "value": {
    "vin": "1C4PJXEG4SW627021",
    "noun": "garage",
    "asOf": "2026-08-10",
    "vehicleId": "VEH-98933ea1",
    "year": 2025,
    "bodyStyle": "suv",
    "drivetrain": "rwd",
    "odometer": 74752,
    "condition": "clean",
    "currentOwnerId": "ID-11f17424",
    "registration": {
      "garageId": "GRG-1e07957b",
      "vin": "1C4PJXEG4SW627021",
      "keepPosition": "NotEnrolled",
      "status": "registered"
    }
  },
  "evidence": {
    "vin": "1C4PJXEG4SW627021",
    "noun": "garage",
    "asOf": "2026-08-10",
    "vehicleId": "VEH-98933ea1",
    "year": 2025,
    "bodyStyle": "suv",
    "drivetrain": "rwd",
    "odometer": 74752,
    "condition": "clean",
    "currentOwnerId": "ID-11f17424",
    "registration": {
      "garageId": "GRG-1e07957b",
      "vin": "1C4PJXEG4SW627021",
      "keepPosition": "NotEnrolled",
      "status": "registered"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "spec-sheet-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

Fulfill & operate

remove

garage.remove · POST /garages/remove · gate key · sandbox · answers GarageRemove@1

No input — this capability takes no request body.

Dooraggregator.vin serves this noun on its two routes: / (the landing) · /1C4PJXEG4SW627021 (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.

EmitsVehicle.removed@1.

the SDK — garage.remove
import { garage } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await garage.remove()
POST /garages/remove
curl -X POST https://apis.vin/garages/remove \
  -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:09.848Z · HTTP 200
{
  "type": "OK",
  "answers": "GarageRemove@1",
  "value": {
    "vin": "1HGCM82633A004352",
    "noun": "garage",
    "asOf": "2026-08-10",
    "vehicleId": "VEH-ff80c984",
    "year": 2025,
    "bodyStyle": "sedan",
    "drivetrain": "fwd",
    "odometer": 32490,
    "condition": "clean",
    "status": "Decoded",
    "currentOwnerId": "ID-11f17424",
    "removal": {
      "keepPosition": "NotEnrolled",
      "status": "not-enrolled",
      "basis": "keep-own-valued-disposed-exit"
    }
  },
  "evidence": {
    "vin": "1HGCM82633A004352",
    "noun": "garage",
    "asOf": "2026-08-10",
    "vehicleId": "VEH-ff80c984",
    "year": 2025,
    "bodyStyle": "sedan",
    "drivetrain": "fwd",
    "odometer": 32490,
    "condition": "clean",
    "status": "Decoded",
    "currentOwnerId": "ID-11f17424",
    "removal": {
      "keepPosition": "NotEnrolled",
      "status": "not-enrolled",
      "basis": "keep-own-valued-disposed-exit"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "spec-sheet-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.

Vehicle

Modeled

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

Garage · Class model

Garage · State machine

Garage · State machine

Garage · Sequence


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