router
The router noun — identity, lifecycle, events, and every capability as an anchored section: 2 capabilities, 0 live, 2 sandbox, 0 declared.
router 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 aggregator.vin.
Identity
| Noun | router |
| Pillar | Services (facets: 1 services · 1 commerce) |
| Capabilities | 2 — 0 live · 2 sandbox · 0 declared |
| Entities | Payment |
| Doors | aggregator.vin |
| SDK | Vin.router.* from apis.vin |
| Address | /catalog/router#{action} — the anchor IS the wire name minus router. |
Events
The vocabulary this noun can append to the record — 1 past-tense, versioned event type, each linked to the capability that emits it:
Routing.routed@1— emitted byroute
Quote & price
quote
router.quote · GET /routers/quote · gate none · sandbox · answers RouterQuote@1
No input — this capability takes no request body.
Door — aggregator.vin serves this noun on its two routes: / (the landing) · /1C4RJXN62RW174513 (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.
import { router } from 'apis.vin'
// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await router.quote()curl 'https://apis.vin/routers/quote'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.
{
"type": "OK",
"answers": "RouterQuote@1",
"value": {
"vin": "1HGCM82633A004352",
"noun": "router",
"asOf": "2026-08-10",
"payment": {
"status": "no-payment-story-on-file"
},
"quote": {
"status": "quoted",
"methods": [
"ach",
"card",
"wire",
"check",
"rdc"
],
"fees": {
"status": "not-posted",
"basis": "no-world-money-law"
},
"basis": "catalog-method-enum"
}
},
"evidence": {
"vin": "1HGCM82633A004352",
"noun": "router",
"asOf": "2026-08-10",
"payment": {
"status": "no-payment-story-on-file"
},
"quote": {
"status": "quoted",
"methods": [
"ach",
"card",
"wire",
"check",
"rdc"
],
"fees": {
"status": "not-posted",
"basis": "no-world-money-law"
},
"basis": "catalog-method-enum"
}
},
"provenance": {
"simulated": true,
"environment": "sandbox",
"source": "cashier-window-sandbox"
},
"events": [],
"meter": {
"charged": "0.00",
"posted": false
}
}More actions
route
router.route · POST /routers/route · gate key · sandbox · answers RouterRoute@1
No input — this capability takes no request body.
Door — aggregator.vin serves this noun on its two routes: / (the landing) · /1C4RJXN62RW174513 (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 — Routing.routed@1.
import { router } from 'apis.vin'
// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await router.route()curl -X POST https://apis.vin/routers/route \
-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.
{
"type": "OK",
"answers": "RouterRoute@1",
"value": {
"vin": "1HGCM82633A004352",
"noun": "router",
"asOf": "2026-08-10",
"payment": {
"status": "no-payment-story-on-file"
},
"route": {
"status": "not-derivable",
"basis": "no-world-fee-law",
"methods": [
"ach",
"card",
"wire",
"check",
"rdc"
]
}
},
"evidence": {
"vin": "1HGCM82633A004352",
"noun": "router",
"asOf": "2026-08-10",
"payment": {
"status": "no-payment-story-on-file"
},
"route": {
"status": "not-derivable",
"basis": "no-world-fee-law",
"methods": [
"ach",
"card",
"wire",
"check",
"rdc"
]
}
},
"provenance": {
"simulated": true,
"environment": "sandbox",
"source": "cashier-window-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.
Payment
Modeled
The noun drawn out — its record shape, its lifecycle, and how it is exercised end to end. 3 diagrams, rendered from the estate model.
Router · Class model
Router · State machine
Router · Sequence
Generated from the catalog. Every capability, answer, gate, and entity on this page is a rendered descriptor — it cannot drift from the wire.