vindex

vindex

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

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

Identity


Noun	`vindex`
Pillar	Data (facets: 1 data)
Capabilities	1 — 0 live · 1 sandbox · 0 declared
Entities	`VindexResolve`
Doors	`vindex.vin`
SDK	`Vin.vindex.*` from `apis.vin`
Address	`/catalog/vindex#{action}` — the anchor IS the wire name minus `vindex.`

Events

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

Vindex.resolved@1 — emitted by resolve

More actions

resolve

vindex.resolve · GET /vindex/resolve · gate none · sandbox · answers VindexResolve@1

Field	Type	Required	Notes
`vin`	`string`	yes	length 11–17
`market`	`string`	no	—
`asOf`	`string`	no	—
`halfLifeDays`	`integer`	no	—
`alpha`	`number`	no	—

Door — vindex.vin serves this noun on its two routes: / (the landing) · /1FA6P8CF2S5400156 (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 — Vindex.resolved@1.

the SDK — vindex.resolve

import { vindex } from 'apis.vin'

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

GET /vindex/resolve

curl 'https://apis.vin/vindex/resolve?vin=1FA6P8CF2S5400156'

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.

VindexResolve

Schema

Property	Type	Notes
`outcome`	`VindexResolveOutcome`	—
`vin`	`string`	—
`market`	`string`	—
`squish`	`string`	positions 1-8 · 10-11
`matchString`	`string`	the schema match string
`wmiCandidates`	`string[]`	—
`modelYearCandidates`	`int[]`	—
`bindings`	`ManifestBinding[]`	RESOLVED: one per model-year binding
`advisories`	`string[]`	—
`note`	`string`	NO_BINDING: the posted gap is the answer
`reason`	`string`	INVALID_VIN: length\|charset\|checkdigit\|unknown-market
`message`	`string`	INVALID_VIN: the registrar voice

Relationships

From	To	Cardinality	As
`vindex`	`ladder`	`1:1`	`ladderPath`
`vindex`	`cut`	`1:0..*`	`candidateCut`
`vindex`	`vehicle`	`1:1`	`identifies`

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