docs.vin

key

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

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

Identity

Nounkey
PillarServices (facets: 5 data · 8 services · 3 commerce)
Capabilities16 — 0 live · 16 sandbox · 0 declared
EntitiesRepairOrder
Doorsaggregator.vin
SDKVin.key.* from apis.vin
Address/catalog/key#{action} — the anchor IS the wire name minus key.

Events

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

Discover & read

fitment

key.fitment · GET /keys/fitment · gate none · sandbox · answers KeyFitment@1

FieldTypeRequiredNotes
vinstringno—

Door — aggregator.vin serves this noun on its two routes: / (the landing) · /1GKKNXLS2MZ214073 (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 — key.fitment
import { key } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await key.fitment({"vin":"1GKKNXLS2MZ214073"})
GET /keys/fitment
curl 'https://apis.vin/keys/fitment?vin=1GKKNXLS2MZ214073'

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:13.002Z · HTTP 200
{
  "type": "OK",
  "answers": "KeyFitment@1",
  "value": {
    "vin": "1GKKNXLS2MZ214073",
    "noun": "key",
    "asOf": "2026-08-10",
    "standing": "active",
    "fitment": {
      "fits": true,
      "keyType": "smart-proximity"
    }
  },
  "evidence": {
    "vin": "1GKKNXLS2MZ214073",
    "noun": "key",
    "asOf": "2026-08-10",
    "standing": "active",
    "fitment": {
      "fits": true,
      "keyType": "smart-proximity"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "compliance-keys-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

keyCodeLookup

key.keyCodeLookup · GET /keys/key-code-lookup · gate none · sandbox · answers KeyKeyCodeLookup@1

FieldTypeRequiredNotes
vinstringno—

Door — aggregator.vin serves this noun on its two routes: / (the landing) · /1GKKNXLS2MZ214073 (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 — key.keyCodeLookup
import { key } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await key.keyCodeLookup({"vin":"1GKKNXLS2MZ214073"})
GET /keys/key-code-lookup
curl 'https://apis.vin/keys/key-code-lookup?vin=1GKKNXLS2MZ214073'

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:13.009Z · HTTP 200
{
  "type": "OK",
  "answers": "KeyKeyCodeLookup@1",
  "value": {
    "vin": "1GKKNXLS2MZ214073",
    "noun": "key",
    "asOf": "2026-08-10",
    "standing": "active",
    "keyCode": {
      "code": "KC-0cc92eb6",
      "keyType": "smart-proximity"
    }
  },
  "evidence": {
    "vin": "1GKKNXLS2MZ214073",
    "noun": "key",
    "asOf": "2026-08-10",
    "standing": "active",
    "keyCode": {
      "code": "KC-0cc92eb6",
      "keyType": "smart-proximity"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "compliance-keys-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

countRead

key.countRead · GET /keys/count-read · gate none · sandbox · answers KeyCountRead@1

FieldTypeRequiredNotes
vinstringno—

Door — aggregator.vin serves this noun on its two routes: / (the landing) · /1GKKNXLS2MZ214073 (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 — key.countRead
import { key } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await key.countRead({"vin":"1GKKNXLS2MZ214073"})
GET /keys/count-read
curl 'https://apis.vin/keys/count-read?vin=1GKKNXLS2MZ214073'

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.996Z · HTTP 200
{
  "type": "OK",
  "answers": "KeyCountRead@1",
  "value": {
    "vin": "1GKKNXLS2MZ214073",
    "noun": "key",
    "asOf": "2026-08-10",
    "standing": "active",
    "keys": {
      "physical": 2,
      "digitalActive": 1
    }
  },
  "evidence": {
    "vin": "1GKKNXLS2MZ214073",
    "noun": "key",
    "asOf": "2026-08-10",
    "standing": "active",
    "keys": {
      "physical": 2,
      "digitalActive": 1
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "compliance-keys-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

immobilizerSpec

key.immobilizerSpec · GET /keys/immobilizer-spec · gate none · sandbox · answers KeyImmobilizerSpec@1

FieldTypeRequiredNotes
vinstringno—

Door — aggregator.vin serves this noun on its two routes: / (the landing) · /1GKKNXLS2MZ214073 (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 — key.immobilizerSpec
import { key } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await key.immobilizerSpec({"vin":"1GKKNXLS2MZ214073"})
GET /keys/immobilizer-spec
curl 'https://apis.vin/keys/immobilizer-spec?vin=1GKKNXLS2MZ214073'

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:13.009Z · HTTP 200
{
  "type": "OK",
  "answers": "KeyImmobilizerSpec@1",
  "value": {
    "vin": "1GKKNXLS2MZ214073",
    "noun": "key",
    "asOf": "2026-08-10",
    "standing": "active",
    "spec": {
      "transponder": "rolling-code",
      "frequencyMhz": 434,
      "cloneable": false,
      "keyType": "smart-proximity"
    }
  },
  "evidence": {
    "vin": "1GKKNXLS2MZ214073",
    "noun": "key",
    "asOf": "2026-08-10",
    "standing": "active",
    "spec": {
      "transponder": "rolling-code",
      "frequencyMhz": 434,
      "cloneable": false,
      "keyType": "smart-proximity"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "compliance-keys-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

Quote & price

quote

key.quote · POST /keys/quote · gate offer · sandbox · answers KeyQuote@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 — aggregator.vin serves this noun on its two routes: / (the landing) · /1GKKNXLS2MZ214073 (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 — Key.quoted@1.

the SDK — key.quote
import { key } from 'apis.vin'

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

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:13.017Z · HTTP 200
{
  "type": "OK",
  "answers": "KeyQuote@1",
  "value": {
    "vin": "1GKKNXLS2MZ214073",
    "noun": "key",
    "asOf": "2026-08-10",
    "standing": "active",
    "quote": {
      "id": "KQ-c1e8d081",
      "amountCents": 38500,
      "keyType": "smart-proximity",
      "currency": "USD",
      "status": "extended"
    }
  },
  "evidence": {
    "vin": "1GKKNXLS2MZ214073",
    "noun": "key",
    "asOf": "2026-08-10",
    "standing": "active",
    "quote": {
      "id": "KQ-c1e8d081",
      "amountCents": 38500,
      "keyType": "smart-proximity",
      "currency": "USD",
      "status": "extended"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "compliance-keys-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

Apply & book

order

key.order · POST /keys/order · gate offer · sandbox · answers KeyOrder@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 — aggregator.vin serves this noun on its two routes: / (the landing) · /1GKKNXLS2MZ214073 (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 — Key.ordered@1 · Order.placed@1 · ServiceOrder.settled@1.

the SDK — key.order
import { key } from 'apis.vin'

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

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:13.010Z · HTTP 200
{
  "type": "OK",
  "answers": "KeyOrder@1",
  "value": {
    "vin": "1GKKNXLS2MZ214073",
    "noun": "key",
    "asOf": "2026-08-10",
    "standing": "active",
    "order": {
      "id": "ORD-70ea5909",
      "item": "replacement key",
      "status": "placed",
      "amountCents": 32000,
      "currency": "USD"
    },
    "payer": {
      "name": "Ava Good",
      "castRow": "super-prime",
      "creditTier": "super-prime"
    }
  },
  "evidence": {
    "vin": "1GKKNXLS2MZ214073",
    "noun": "key",
    "asOf": "2026-08-10",
    "standing": "active",
    "order": {
      "id": "ORD-70ea5909",
      "item": "replacement key",
      "status": "placed",
      "amountCents": 32000,
      "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
  }
}

digitalProvision

key.digitalProvision · POST /keys/digital-provision · gate offer · sandbox · answers KeyDigitalProvision@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 — aggregator.vin serves this noun on its two routes: / (the landing) · /1GKKNXLS2MZ214073 (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 — Key.digitalProvisioned@1.

the SDK — key.digitalProvision
import { key } from 'apis.vin'

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

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.999Z · HTTP 200
{
  "type": "OK",
  "answers": "KeyDigitalProvision@1",
  "value": {
    "vin": "1GKKNXLS2MZ214073",
    "noun": "key",
    "asOf": "2026-08-10",
    "standing": "active",
    "provision": {
      "id": "DKY-5f260e5d",
      "status": "provisioned",
      "channel": "active"
    }
  },
  "evidence": {
    "vin": "1GKKNXLS2MZ214073",
    "noun": "key",
    "asOf": "2026-08-10",
    "standing": "active",
    "provision": {
      "id": "DKY-5f260e5d",
      "status": "provisioned",
      "channel": "active"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "compliance-keys-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

Pay & settle

pay

key.pay · POST /keys/pay · gate offer · sandbox · answers KeyPay@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 — aggregator.vin serves this noun on its two routes: / (the landing) · /1GKKNXLS2MZ214073 (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 — Key.charged@1 · ServiceOrder.settled@1.

the SDK — key.pay
import { key } from 'apis.vin'

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

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:13.010Z · HTTP 200
{
  "type": "OK",
  "answers": "KeyPay@1",
  "value": {
    "vin": "1GKKNXLS2MZ214073",
    "noun": "key",
    "asOf": "2026-08-10",
    "standing": "active",
    "payment": {
      "id": "PAY-d5ddc66f",
      "status": "settled",
      "amountCents": 32000,
      "currency": "USD"
    },
    "payer": {
      "name": "Ava Good",
      "castRow": "super-prime",
      "creditTier": "super-prime"
    }
  },
  "evidence": {
    "vin": "1GKKNXLS2MZ214073",
    "noun": "key",
    "asOf": "2026-08-10",
    "standing": "active",
    "payment": {
      "id": "PAY-d5ddc66f",
      "status": "settled",
      "amountCents": 32000,
      "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
  }
}

Fulfill & operate

replace

key.replace · POST /keys/replace · gate offer · sandbox · answers KeyReplace@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 — aggregator.vin serves this noun on its two routes: / (the landing) · /1GKKNXLS2MZ214073 (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 — Key.replaced@1.

the SDK — key.replace
import { key } from 'apis.vin'

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

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:13.020Z · HTTP 200
{
  "type": "OK",
  "answers": "KeyReplace@1",
  "value": {
    "vin": "1GKKNXLS2MZ214073",
    "noun": "key",
    "asOf": "2026-08-10",
    "standing": "active",
    "replacement": {
      "id": "KEY-312acf49",
      "status": "replaced",
      "keyType": "smart-proximity",
      "amountCents": 32000,
      "currency": "USD"
    },
    "payer": {
      "name": "Ava Good",
      "castRow": "super-prime",
      "creditTier": "super-prime"
    }
  },
  "evidence": {
    "vin": "1GKKNXLS2MZ214073",
    "noun": "key",
    "asOf": "2026-08-10",
    "standing": "active",
    "replacement": {
      "id": "KEY-312acf49",
      "status": "replaced",
      "keyType": "smart-proximity",
      "amountCents": 32000,
      "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
  }
}

program

key.program · POST /keys/program · gate offer · sandbox · answers KeyProgram@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 — aggregator.vin serves this noun on its two routes: / (the landing) · /1GKKNXLS2MZ214073 (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 — Key.programmed@1.

the SDK — key.program
import { key } from 'apis.vin'

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

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:13.017Z · HTTP 200
{
  "type": "OK",
  "answers": "KeyProgram@1",
  "value": {
    "vin": "1GKKNXLS2MZ214073",
    "noun": "key",
    "asOf": "2026-08-10",
    "standing": "active",
    "work": {
      "id": "KEY-312acf49",
      "status": "programmed",
      "keyType": "smart-proximity"
    }
  },
  "evidence": {
    "vin": "1GKKNXLS2MZ214073",
    "noun": "key",
    "asOf": "2026-08-10",
    "standing": "active",
    "work": {
      "id": "KEY-312acf49",
      "status": "programmed",
      "keyType": "smart-proximity"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "compliance-keys-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

Lifecycle & state

custodyTransfer

key.custodyTransfer · POST /keys/custody-transfer · gate key · sandbox · answers KeyCustodyTransfer@1

No input — this capability takes no request body.

Door — aggregator.vin serves this noun on its two routes: / (the landing) · /1GKKNXLS2MZ214073 (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 — Key.custodyTransferred@1.

the SDK — key.custodyTransfer
import { key } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await key.custodyTransfer()
POST /keys/custody-transfer
curl -X POST https://apis.vin/keys/custody-transfer \
  -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.887Z · HTTP 200
{
  "type": "OK",
  "answers": "KeyCustodyTransfer@1",
  "value": {
    "vin": "1HGCM82633A004352",
    "noun": "key",
    "asOf": "2026-08-10",
    "standing": "active",
    "transfer": {
      "status": "transferred",
      "keyId": "KEY-235f3b49",
      "to": "Ava Good"
    }
  },
  "evidence": {
    "vin": "1HGCM82633A004352",
    "noun": "key",
    "asOf": "2026-08-10",
    "standing": "active",
    "transfer": {
      "status": "transferred",
      "keyId": "KEY-235f3b49",
      "to": "Ava Good"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "compliance-keys-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

More actions

afterHoursDispense

key.afterHoursDispense · POST /keys/after-hours-dispense · gate key · sandbox · answers KeyAfterHoursDispense@1

No input — this capability takes no request body.

Door — aggregator.vin serves this noun on its two routes: / (the landing) · /1GKKNXLS2MZ214073 (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 — Key.afterHoursDispensed@1.

the SDK — key.afterHoursDispense
import { key } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await key.afterHoursDispense()
POST /keys/after-hours-dispense
curl -X POST https://apis.vin/keys/after-hours-dispense \
  -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.887Z · HTTP 200
{
  "type": "OK",
  "answers": "KeyAfterHoursDispense@1",
  "value": {
    "vin": "1HGCM82633A004352",
    "noun": "key",
    "asOf": "2026-08-10",
    "standing": "active",
    "dispense": {
      "status": "no-appointment-on-file"
    }
  },
  "evidence": {
    "vin": "1HGCM82633A004352",
    "noun": "key",
    "asOf": "2026-08-10",
    "standing": "active",
    "dispense": {
      "status": "no-appointment-on-file"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "compliance-keys-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

custodyLog

key.custodyLog · GET /keys/custody-log · gate none · sandbox · answers KeyCustodyLog@1

No input — this capability takes no request body.

Door — aggregator.vin serves this noun on its two routes: / (the landing) · /1GKKNXLS2MZ214073 (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 — key.custodyLog
import { key } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await key.custodyLog()
GET /keys/custody-log
curl 'https://apis.vin/keys/custody-log'

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.887Z · HTTP 200
{
  "type": "OK",
  "answers": "KeyCustodyLog@1",
  "value": {
    "vin": "1HGCM82633A004352",
    "noun": "key",
    "asOf": "2026-08-10",
    "standing": "active",
    "log": {
      "keyId": "KEY-235f3b49",
      "events": [
        {
          "date": "2026-01-19",
          "event": "key-cut-recorded"
        }
      ]
    }
  },
  "evidence": {
    "vin": "1HGCM82633A004352",
    "noun": "key",
    "asOf": "2026-08-10",
    "standing": "active",
    "log": {
      "keyId": "KEY-235f3b49",
      "events": [
        {
          "date": "2026-01-19",
          "event": "key-cut-recorded"
        }
      ]
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "compliance-keys-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

cut

key.cut · POST /keys/cut · gate offer · sandbox · answers KeyCut@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 — aggregator.vin serves this noun on its two routes: / (the landing) · /1GKKNXLS2MZ214073 (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 — Key.cut@1.

the SDK — key.cut
import { key } from 'apis.vin'

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

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.998Z · HTTP 200
{
  "type": "OK",
  "answers": "KeyCut@1",
  "value": {
    "vin": "1GKKNXLS2MZ214073",
    "noun": "key",
    "asOf": "2026-08-10",
    "standing": "active",
    "work": {
      "id": "KEY-312acf49",
      "status": "cut",
      "keyType": "smart-proximity"
    }
  },
  "evidence": {
    "vin": "1GKKNXLS2MZ214073",
    "noun": "key",
    "asOf": "2026-08-10",
    "standing": "active",
    "work": {
      "id": "KEY-312acf49",
      "status": "cut",
      "keyType": "smart-proximity"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "compliance-keys-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

reflashImmobilizer

key.reflashImmobilizer · POST /keys/reflash-immobilizer · gate offer · sandbox · answers KeyReflashImmobilizer@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 — aggregator.vin serves this noun on its two routes: / (the landing) · /1GKKNXLS2MZ214073 (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 — Key.reflashImmobilizered@1.

the SDK — key.reflashImmobilizer
import { key } from 'apis.vin'

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

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:13.018Z · HTTP 200
{
  "type": "OK",
  "answers": "KeyReflashImmobilizer@1",
  "value": {
    "vin": "1GKKNXLS2MZ214073",
    "noun": "key",
    "asOf": "2026-08-10",
    "standing": "active",
    "work": {
      "id": "IMM-c76cb5b8",
      "status": "reflashed"
    }
  },
  "evidence": {
    "vin": "1GKKNXLS2MZ214073",
    "noun": "key",
    "asOf": "2026-08-10",
    "standing": "active",
    "work": {
      "id": "IMM-c76cb5b8",
      "status": "reflashed"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "compliance-keys-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

unlock

key.unlock · POST /keys/unlock · gate offer · sandbox · answers KeyUnlock@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 — aggregator.vin serves this noun on its two routes: / (the landing) · /1GKKNXLS2MZ214073 (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 — Key.unlocked@1.

the SDK — key.unlock
import { key } from 'apis.vin'

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

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:13.023Z · HTTP 200
{
  "type": "OK",
  "answers": "KeyUnlock@1",
  "value": {
    "vin": "1GKKNXLS2MZ214073",
    "noun": "key",
    "asOf": "2026-08-10",
    "standing": "active",
    "unlock": {
      "status": "unlocked",
      "channel": "active"
    }
  },
  "evidence": {
    "vin": "1GKKNXLS2MZ214073",
    "noun": "key",
    "asOf": "2026-08-10",
    "standing": "active",
    "unlock": {
      "status": "unlocked",
      "channel": "active"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "compliance-keys-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.

RepairOrder

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

inventory

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

keyLocksmith

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

On this page

Identity
Events
Discover & read
fitment
keyCodeLookup
countRead
immobilizerSpec
Quote & price
quote
Apply & book
order
digitalProvision
Pay & settle
pay
Fulfill & operate
replace
program
Lifecycle & state
custodyTransfer
More actions
afterHoursDispense
custodyLog
cut
reflashImmobilizer
unlock
Data model
RepairOrder