fiMenu
The fiMenu noun — identity, lifecycle, events, and every capability as an anchored section: 7 capabilities, 0 live, 7 sandbox, 0 declared.
fiMenu is one of the estate's 317 automotive nouns — a job a car needs done. It carries 7 capabilities: 0 live, 7 sandbox, 0 declared · doors aggregator.vin.
Identity
| Noun | fiMenu |
| Pillar | Data (facets: 4 data · 3 services) |
| Capabilities | 7 — 0 live · 7 sandbox · 0 declared |
| Entities | FniMenu |
| Doors | aggregator.vin |
| SDK | Vin.fiMenu.* from apis.vin |
| Address | /catalog/fiMenu#{action} — the anchor IS the wire name minus fiMenu. |
Events
The vocabulary this noun can append to the record — 3 past-tense, versioned event types, each linked to the capability that emits it:
FiMenu.built@1— emitted bybuildFiMenu.complianceChecked@1— emitted bycomplianceFiMenu.presented@1— emitted bypresent
Discover & read
eligibility
fiMenu.eligibility · GET /fi-menus/eligibility · gate key · sandbox · answers FiMenuEligibility@1
| Field | Type | Required | Notes |
|---|---|---|---|
vin | string | no | — |
Door — aggregator.vin serves this noun on its two routes: / (the landing) · /2GC4KNEY1T1113813 (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 { fiMenu } from 'apis.vin'
// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await fiMenu.eligibility({"vin":"2GC4KNEY1T1113813"})curl 'https://apis.vin/fi-menus/eligibility?vin=2GC4KNEY1T1113813'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": "FiMenuEligibility@1",
"value": {
"eligible": [
{
"productType": "VSC",
"planCode": "VSC-PLAT",
"vehicleClass": "B",
"terms": [
{
"termMonths": 36,
"termMiles": 36000,
"dealerCost": {
"currency": "USD",
"minorUnits": 135000
},
"retailCost": {
"currency": "USD",
"minorUnits": 221700
}
},
{
"termMonths": 48,
"termMiles": 50000,
"dealerCost": {
"currency": "USD",
"minorUnits": 152000
},
"retailCost": {
"currency": "USD",
"minorUnits": 252000
}
},
{
"termMonths": 60,
"termMiles": 75000,
"dealerCost": {
"currency": "USD",
"minorUnits": 171000
},
"retailCost": {
"currency": "USD",
"minorUnits": 282300
}
}
]
},
{
"productType": "GAP",
"planCode": "GAP-STD",
"vehicleClass": "B",
"terms": [
{
"termMonths": 60,
"termMiles": 0,
"dealerCost": {
"currency": "USD",
"minorUnits": 42500
},
"retailCost": {
"currency": "USD",
"minorUnits": 90400
}
},
{
"termMonths": 72,
"termMiles": 0,
"dealerCost": {
"currency": "USD",
"minorUnits": 47500
},
"retailCost": {
"currency": "USD",
"minorUnits": 100500
}
}
]
},
{
"productType": "PPM",
"planCode": "PPM-36",
"vehicleClass": "B",
"terms": [
{
"termMonths": 36,
"termMiles": 36000,
"dealerCost": {
"currency": "USD",
"minorUnits": 32000
},
"retailCost": {
"currency": "USD",
"minorUnits": 70200
}
}
]
},
{
"productType": "EWT",
"planCode": "EWT-STD",
"vehicleClass": "B",
"terms": [
{
"termMonths": 60,
"termMiles": 60000,
"dealerCost": {
"currency": "USD",
"minorUnits": 26000
},
"retailCost": {
"currency": "USD",
"minorUnits": 60100
}
}
]
},
{
"productType": "TIRE",
"planCode": "TIRE-STD",
"vehicleClass": "B",
"terms": [
{
"termMonths": 36,
"termMiles": 36000,
"dealerCost": {
"currency": "USD",
"minorUnits": 34000
},
"retailCost": {
"currency": "USD",
"minorUnits": 80300
}
}
]
},
{
"productType": "KEY",
"planCode": "KEY-STD",
"vehicleClass": "B",
"terms": [
{
"termMonths": 60,
"termMiles": 0,
"dealerCost": {
"currency": "USD",
"minorUnits": 15000
},
"retailCost": {
"currency": "USD",
"minorUnits": 39900
}
}
]
},
{
"productType": "ETCH",
"planCode": "ETCH-NEW",
"vehicleClass": "B",
"terms": [
{
"termMonths": 60,
"termMiles": 0,
"dealerCost": {
"currency": "USD",
"minorUnits": 9000
},
"retailCost": {
"currency": "USD",
"minorUnits": 30200
}
}
]
}
],
"count": 7,
"provenance": {
"environment": "sandbox",
"simulated": true,
"provider": "fni-administrator-sandbox"
}
},
"evidence": {
"eligible": [
{
"productType": "VSC",
"planCode": "VSC-PLAT",
"vehicleClass": "B",
"terms": [
{
"termMonths": 36,
"termMiles": 36000,
"dealerCost": {
"currency": "USD",
"minorUnits": 135000
},
"retailCost": {
"currency": "USD",
"minorUnits": 221700
}
},
{
"termMonths": 48,
"termMiles": 50000,
"dealerCost": {
"currency": "USD",
"minorUnits": 152000
},
"retailCost": {
"currency": "USD",
"minorUnits": 252000
}
},
{
"termMonths": 60,
"termMiles": 75000,
"dealerCost": {
"currency": "USD",
"minorUnits": 171000
},
"retailCost": {
"currency": "USD",
"minorUnits": 282300
}
}
]
},
{
"productType": "GAP",
"planCode": "GAP-STD",
"vehicleClass": "B",
"terms": [
{
"termMonths": 60,
"termMiles": 0,
"dealerCost": {
"currency": "USD",
"minorUnits": 42500
},
"retailCost": {
"currency": "USD",
"minorUnits": 90400
}
},
{
"termMonths": 72,
"termMiles": 0,
"dealerCost": {
"currency": "USD",
"minorUnits": 47500
},
"retailCost": {
"currency": "USD",
"minorUnits": 100500
}
}
]
},
{
"productType": "PPM",
"planCode": "PPM-36",
"vehicleClass": "B",
"terms": [
{
"termMonths": 36,
"termMiles": 36000,
"dealerCost": {
"currency": "USD",
"minorUnits": 32000
},
"retailCost": {
"currency": "USD",
"minorUnits": 70200
}
}
]
},
{
"productType": "EWT",
"planCode": "EWT-STD",
"vehicleClass": "B",
"terms": [
{
"termMonths": 60,
"termMiles": 60000,
"dealerCost": {
"currency": "USD",
"minorUnits": 26000
},
"retailCost": {
"currency": "USD",
"minorUnits": 60100
}
}
]
},
{
"productType": "TIRE",
"planCode": "TIRE-STD",
"vehicleClass": "B",
"terms": [
{
"termMonths": 36,
"termMiles": 36000,
"dealerCost": {
"currency": "USD",
"minorUnits": 34000
},
"retailCost": {
"currency": "USD",
"minorUnits": 80300
}
}
]
},
{
"productType": "KEY",
"planCode": "KEY-STD",
"vehicleClass": "B",
"terms": [
{
"termMonths": 60,
"termMiles": 0,
"dealerCost": {
"currency": "USD",
"minorUnits": 15000
},
"retailCost": {
"currency": "USD",
"minorUnits": 39900
}
}
]
},
{
"productType": "ETCH",
"planCode": "ETCH-NEW",
"vehicleClass": "B",
"terms": [
{
"termMonths": 60,
"termMiles": 0,
"dealerCost": {
"currency": "USD",
"minorUnits": 9000
},
"retailCost": {
"currency": "USD",
"minorUnits": 30200
}
}
]
}
],
"count": 7,
"provenance": {
"environment": "sandbox",
"simulated": true,
"provider": "fni-administrator-sandbox"
}
},
"provenance": {
"simulated": true,
"environment": "sandbox",
"source": "fni-administrator-sandbox"
},
"events": [],
"meter": {
"charged": "0.00",
"posted": false
},
"connect": {
"type": "OFFER",
"kind": "connect",
"reason": "CONNECTION_ABSENT",
"portClass": "fni-administrator",
"state": "absent",
"url": "https://integrates.vin/connect/fni-administrator",
"message": "fiMenu.eligibility is live via connection — certified, connect to activate: complete the fni-administrator link ceremony at https://integrates.vin/connect/fni-administrator. The credential vault (auth.vin) holds the token, and the same call answers simulated:false — activation is the token, never a deploy."
}
}penetrationReport
fiMenu.penetrationReport · GET /fi-menus/penetration-report · gate none · sandbox · answers FiMenuPenetrationReport@1
No input — this capability takes no request body.
Door — aggregator.vin serves this noun on its two routes: / (the landing) · /2GC4KNEY1T1113813 (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 { fiMenu } from 'apis.vin'
// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await fiMenu.penetrationReport()curl 'https://apis.vin/fi-menus/penetration-report'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": "FiMenuPenetrationReport@1",
"value": {
"id": "fiMenu_decc07fc",
"dealId": "deal_b04fd1a6",
"products": [],
"presented": true,
"declined": true,
"selected": []
},
"evidence": {
"id": "fiMenu_decc07fc",
"dealId": "deal_b04fd1a6",
"products": [],
"presented": true,
"declined": true,
"selected": []
},
"provenance": {
"simulated": true,
"environment": "sandbox",
"source": "fi-menu-sandbox"
},
"events": [],
"meter": {
"charged": "0.00",
"posted": false
}
}Quote & price
rate
fiMenu.rate · GET /fi-menus/rate · gate key · sandbox · answers FiMenuRate@1
| Field | Type | Required | Notes |
|---|---|---|---|
vin | string | no | — |
Door — aggregator.vin serves this noun on its two routes: / (the landing) · /2GC4KNEY1T1113813 (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 { fiMenu } from 'apis.vin'
// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await fiMenu.rate({"vin":"2GC4KNEY1T1113813"})curl 'https://apis.vin/fi-menus/rate?vin=2GC4KNEY1T1113813'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": "FiMenuRate@1",
"value": {
"rates": [
{
"productType": "VSC",
"planCode": "VSC-PLAT",
"vehicleClass": "B",
"terms": [
{
"termMonths": 36,
"termMiles": 36000,
"dealerCost": {
"currency": "USD",
"minorUnits": 135000
},
"retailCost": {
"currency": "USD",
"minorUnits": 221700
}
},
{
"termMonths": 48,
"termMiles": 50000,
"dealerCost": {
"currency": "USD",
"minorUnits": 152000
},
"retailCost": {
"currency": "USD",
"minorUnits": 252000
}
},
{
"termMonths": 60,
"termMiles": 75000,
"dealerCost": {
"currency": "USD",
"minorUnits": 171000
},
"retailCost": {
"currency": "USD",
"minorUnits": 282300
}
}
]
},
{
"productType": "GAP",
"planCode": "GAP-STD",
"vehicleClass": "B",
"terms": [
{
"termMonths": 60,
"termMiles": 0,
"dealerCost": {
"currency": "USD",
"minorUnits": 42500
},
"retailCost": {
"currency": "USD",
"minorUnits": 90400
}
},
{
"termMonths": 72,
"termMiles": 0,
"dealerCost": {
"currency": "USD",
"minorUnits": 47500
},
"retailCost": {
"currency": "USD",
"minorUnits": 100500
}
}
]
},
{
"productType": "PPM",
"planCode": "PPM-36",
"vehicleClass": "B",
"terms": [
{
"termMonths": 36,
"termMiles": 36000,
"dealerCost": {
"currency": "USD",
"minorUnits": 32000
},
"retailCost": {
"currency": "USD",
"minorUnits": 70200
}
}
]
},
{
"productType": "EWT",
"planCode": "EWT-STD",
"vehicleClass": "B",
"terms": [
{
"termMonths": 60,
"termMiles": 60000,
"dealerCost": {
"currency": "USD",
"minorUnits": 26000
},
"retailCost": {
"currency": "USD",
"minorUnits": 60100
}
}
]
},
{
"productType": "TIRE",
"planCode": "TIRE-STD",
"vehicleClass": "B",
"terms": [
{
"termMonths": 36,
"termMiles": 36000,
"dealerCost": {
"currency": "USD",
"minorUnits": 34000
},
"retailCost": {
"currency": "USD",
"minorUnits": 80300
}
}
]
},
{
"productType": "KEY",
"planCode": "KEY-STD",
"vehicleClass": "B",
"terms": [
{
"termMonths": 60,
"termMiles": 0,
"dealerCost": {
"currency": "USD",
"minorUnits": 15000
},
"retailCost": {
"currency": "USD",
"minorUnits": 39900
}
}
]
},
{
"productType": "ETCH",
"planCode": "ETCH-NEW",
"vehicleClass": "B",
"terms": [
{
"termMonths": 60,
"termMiles": 0,
"dealerCost": {
"currency": "USD",
"minorUnits": 9000
},
"retailCost": {
"currency": "USD",
"minorUnits": 30200
}
}
]
}
],
"provenance": {
"environment": "sandbox",
"simulated": true,
"provider": "fni-administrator-sandbox"
}
},
"evidence": {
"rates": [
{
"productType": "VSC",
"planCode": "VSC-PLAT",
"vehicleClass": "B",
"terms": [
{
"termMonths": 36,
"termMiles": 36000,
"dealerCost": {
"currency": "USD",
"minorUnits": 135000
},
"retailCost": {
"currency": "USD",
"minorUnits": 221700
}
},
{
"termMonths": 48,
"termMiles": 50000,
"dealerCost": {
"currency": "USD",
"minorUnits": 152000
},
"retailCost": {
"currency": "USD",
"minorUnits": 252000
}
},
{
"termMonths": 60,
"termMiles": 75000,
"dealerCost": {
"currency": "USD",
"minorUnits": 171000
},
"retailCost": {
"currency": "USD",
"minorUnits": 282300
}
}
]
},
{
"productType": "GAP",
"planCode": "GAP-STD",
"vehicleClass": "B",
"terms": [
{
"termMonths": 60,
"termMiles": 0,
"dealerCost": {
"currency": "USD",
"minorUnits": 42500
},
"retailCost": {
"currency": "USD",
"minorUnits": 90400
}
},
{
"termMonths": 72,
"termMiles": 0,
"dealerCost": {
"currency": "USD",
"minorUnits": 47500
},
"retailCost": {
"currency": "USD",
"minorUnits": 100500
}
}
]
},
{
"productType": "PPM",
"planCode": "PPM-36",
"vehicleClass": "B",
"terms": [
{
"termMonths": 36,
"termMiles": 36000,
"dealerCost": {
"currency": "USD",
"minorUnits": 32000
},
"retailCost": {
"currency": "USD",
"minorUnits": 70200
}
}
]
},
{
"productType": "EWT",
"planCode": "EWT-STD",
"vehicleClass": "B",
"terms": [
{
"termMonths": 60,
"termMiles": 60000,
"dealerCost": {
"currency": "USD",
"minorUnits": 26000
},
"retailCost": {
"currency": "USD",
"minorUnits": 60100
}
}
]
},
{
"productType": "TIRE",
"planCode": "TIRE-STD",
"vehicleClass": "B",
"terms": [
{
"termMonths": 36,
"termMiles": 36000,
"dealerCost": {
"currency": "USD",
"minorUnits": 34000
},
"retailCost": {
"currency": "USD",
"minorUnits": 80300
}
}
]
},
{
"productType": "KEY",
"planCode": "KEY-STD",
"vehicleClass": "B",
"terms": [
{
"termMonths": 60,
"termMiles": 0,
"dealerCost": {
"currency": "USD",
"minorUnits": 15000
},
"retailCost": {
"currency": "USD",
"minorUnits": 39900
}
}
]
},
{
"productType": "ETCH",
"planCode": "ETCH-NEW",
"vehicleClass": "B",
"terms": [
{
"termMonths": 60,
"termMiles": 0,
"dealerCost": {
"currency": "USD",
"minorUnits": 9000
},
"retailCost": {
"currency": "USD",
"minorUnits": 30200
}
}
]
}
],
"provenance": {
"environment": "sandbox",
"simulated": true,
"provider": "fni-administrator-sandbox"
}
},
"provenance": {
"simulated": true,
"environment": "sandbox",
"source": "fni-administrator-sandbox"
},
"events": [],
"meter": {
"charged": "0.00",
"posted": false
},
"connect": {
"type": "OFFER",
"kind": "connect",
"reason": "CONNECTION_ABSENT",
"portClass": "fni-administrator",
"state": "absent",
"url": "https://integrates.vin/connect/fni-administrator",
"message": "fiMenu.rate is live via connection — certified, connect to activate: complete the fni-administrator link ceremony at https://integrates.vin/connect/fni-administrator. The credential vault (auth.vin) holds the token, and the same call answers simulated:false — activation is the token, never a deploy."
}
}Fulfill & operate
build
fiMenu.build · POST /fi-menus/build · gate offer · sandbox · answers FiMenuBuild@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 — aggregator.vin serves this noun on its two routes: / (the landing) · /2GC4KNEY1T1113813 (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 — FiMenu.built@1.
import { fiMenu } from 'apis.vin'
// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await fiMenu.build({"vin":"2GC4KNEY1T1113813"})curl -X POST https://apis.vin/fi-menus/build \
-H 'content-type: application/json' \
-d '{"vin":"2GC4KNEY1T1113813"}'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": "FiMenuBuild@1",
"value": {
"menu": {
"menuId": "MENU-1",
"lines": [
{
"productType": "VSC",
"planCode": "VSC-PLAT",
"termMonths": 36,
"termMiles": 36000,
"dealerCost": {
"currency": "USD",
"minorUnits": 135000
},
"retailCost": {
"currency": "USD",
"minorUnits": 221700
},
"status": "presented"
},
{
"productType": "GAP",
"planCode": "GAP-STD",
"termMonths": 60,
"termMiles": 0,
"dealerCost": {
"currency": "USD",
"minorUnits": 42500
},
"retailCost": {
"currency": "USD",
"minorUnits": 90400
},
"status": "presented"
},
{
"productType": "PPM",
"planCode": "PPM-36",
"termMonths": 36,
"termMiles": 36000,
"dealerCost": {
"currency": "USD",
"minorUnits": 32000
},
"retailCost": {
"currency": "USD",
"minorUnits": 70200
},
"status": "presented"
},
{
"productType": "EWT",
"planCode": "EWT-STD",
"termMonths": 60,
"termMiles": 60000,
"dealerCost": {
"currency": "USD",
"minorUnits": 26000
},
"retailCost": {
"currency": "USD",
"minorUnits": 60100
},
"status": "presented"
},
{
"productType": "TIRE",
"planCode": "TIRE-STD",
"termMonths": 36,
"termMiles": 36000,
"dealerCost": {
"currency": "USD",
"minorUnits": 34000
},
"retailCost": {
"currency": "USD",
"minorUnits": 80300
},
"status": "presented"
},
{
"productType": "KEY",
"planCode": "KEY-STD",
"termMonths": 60,
"termMiles": 0,
"dealerCost": {
"currency": "USD",
"minorUnits": 15000
},
"retailCost": {
"currency": "USD",
"minorUnits": 39900
},
"status": "presented"
},
{
"productType": "ETCH",
"planCode": "ETCH-NEW",
"termMonths": 60,
"termMiles": 0,
"dealerCost": {
"currency": "USD",
"minorUnits": 9000
},
"retailCost": {
"currency": "USD",
"minorUnits": 30200
},
"status": "presented"
}
],
"provenance": {
"environment": "sandbox",
"simulated": true,
"provider": "fni-administrator-sandbox"
}
}
},
"evidence": {
"menu": {
"menuId": "MENU-1",
"lines": [
{
"productType": "VSC",
"planCode": "VSC-PLAT",
"termMonths": 36,
"termMiles": 36000,
"dealerCost": {
"currency": "USD",
"minorUnits": 135000
},
"retailCost": {
"currency": "USD",
"minorUnits": 221700
},
"status": "presented"
},
{
"productType": "GAP",
"planCode": "GAP-STD",
"termMonths": 60,
"termMiles": 0,
"dealerCost": {
"currency": "USD",
"minorUnits": 42500
},
"retailCost": {
"currency": "USD",
"minorUnits": 90400
},
"status": "presented"
},
{
"productType": "PPM",
"planCode": "PPM-36",
"termMonths": 36,
"termMiles": 36000,
"dealerCost": {
"currency": "USD",
"minorUnits": 32000
},
"retailCost": {
"currency": "USD",
"minorUnits": 70200
},
"status": "presented"
},
{
"productType": "EWT",
"planCode": "EWT-STD",
"termMonths": 60,
"termMiles": 60000,
"dealerCost": {
"currency": "USD",
"minorUnits": 26000
},
"retailCost": {
"currency": "USD",
"minorUnits": 60100
},
"status": "presented"
},
{
"productType": "TIRE",
"planCode": "TIRE-STD",
"termMonths": 36,
"termMiles": 36000,
"dealerCost": {
"currency": "USD",
"minorUnits": 34000
},
"retailCost": {
"currency": "USD",
"minorUnits": 80300
},
"status": "presented"
},
{
"productType": "KEY",
"planCode": "KEY-STD",
"termMonths": 60,
"termMiles": 0,
"dealerCost": {
"currency": "USD",
"minorUnits": 15000
},
"retailCost": {
"currency": "USD",
"minorUnits": 39900
},
"status": "presented"
},
{
"productType": "ETCH",
"planCode": "ETCH-NEW",
"termMonths": 60,
"termMiles": 0,
"dealerCost": {
"currency": "USD",
"minorUnits": 9000
},
"retailCost": {
"currency": "USD",
"minorUnits": 30200
},
"status": "presented"
}
],
"provenance": {
"environment": "sandbox",
"simulated": true,
"provider": "fni-administrator-sandbox"
}
}
},
"provenance": {
"simulated": true,
"environment": "sandbox",
"source": "fni-administrator-sandbox"
},
"events": [],
"meter": {
"charged": "0.00",
"posted": false
},
"connect": {
"type": "OFFER",
"kind": "connect",
"reason": "CONNECTION_ABSENT",
"portClass": "fni-administrator",
"state": "absent",
"url": "https://integrates.vin/connect/fni-administrator",
"message": "fiMenu.build is live via connection — certified, connect to activate: complete the fni-administrator link ceremony at https://integrates.vin/connect/fni-administrator. The credential vault (auth.vin) holds the token, and the same call answers simulated:false — activation is the token, never a deploy."
}
}More actions
compliance
fiMenu.compliance · POST /fi-menus/compliance · gate offer · sandbox · answers FiMenuCompliance@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 — aggregator.vin serves this noun on its two routes: / (the landing) · /2GC4KNEY1T1113813 (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 — FiMenu.complianceChecked@1.
import { fiMenu } from 'apis.vin'
// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await fiMenu.compliance({"vin":"2GC4KNEY1T1113813"})curl -X POST https://apis.vin/fi-menus/compliance \
-H 'content-type: application/json' \
-d '{"vin":"2GC4KNEY1T1113813"}'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": "FiMenuCompliance@1",
"value": {
"id": "fiMenu_3cc42504",
"dealId": "deal_a46b82fe",
"products": [],
"presented": false,
"declined": false,
"selected": []
},
"evidence": {
"id": "fiMenu_3cc42504",
"dealId": "deal_a46b82fe",
"products": [],
"presented": false,
"declined": false,
"selected": []
},
"provenance": {
"simulated": true,
"environment": "sandbox",
"source": "fi-menu-sandbox"
},
"events": [],
"meter": {
"charged": "0.00",
"posted": false
}
}paymentImpact
fiMenu.paymentImpact · GET /fi-menus/payment-impact · gate key · sandbox · answers FiMenuPaymentImpact@1
| Field | Type | Required | Notes |
|---|---|---|---|
vin | string | no | — |
Door — aggregator.vin serves this noun on its two routes: / (the landing) · /2GC4KNEY1T1113813 (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 { fiMenu } from 'apis.vin'
// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await fiMenu.paymentImpact({"vin":"2GC4KNEY1T1113813"})curl 'https://apis.vin/fi-menus/payment-impact?vin=2GC4KNEY1T1113813'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": "FiMenuPaymentImpact@1",
"value": {
"id": "fiMenu_1899b8e1",
"dealId": "deal_acbb4c37",
"products": [],
"presented": true,
"declined": true,
"selected": []
},
"evidence": {
"id": "fiMenu_1899b8e1",
"dealId": "deal_acbb4c37",
"products": [],
"presented": true,
"declined": true,
"selected": []
},
"provenance": {
"simulated": true,
"environment": "sandbox",
"source": "fi-menu-sandbox"
},
"events": [],
"meter": {
"charged": "0.00",
"posted": false
}
}present
fiMenu.present · POST /fi-menus/present · gate offer · sandbox · answers FiMenuPresent@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 — aggregator.vin serves this noun on its two routes: / (the landing) · /2GC4KNEY1T1113813 (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 — FiMenu.presented@1.
import { fiMenu } from 'apis.vin'
// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await fiMenu.present({"vin":"2GC4KNEY1T1113813"})curl -X POST https://apis.vin/fi-menus/present \
-H 'content-type: application/json' \
-d '{"vin":"2GC4KNEY1T1113813"}'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": "FiMenuPresent@1",
"value": {
"menu": {
"menuId": "MENU-1",
"lines": [
{
"productType": "VSC",
"planCode": "VSC-PLAT",
"termMonths": 36,
"termMiles": 36000,
"dealerCost": {
"currency": "USD",
"minorUnits": 135000
},
"retailCost": {
"currency": "USD",
"minorUnits": 221700
},
"status": "presented"
},
{
"productType": "GAP",
"planCode": "GAP-STD",
"termMonths": 60,
"termMiles": 0,
"dealerCost": {
"currency": "USD",
"minorUnits": 42500
},
"retailCost": {
"currency": "USD",
"minorUnits": 90400
},
"status": "presented"
},
{
"productType": "PPM",
"planCode": "PPM-36",
"termMonths": 36,
"termMiles": 36000,
"dealerCost": {
"currency": "USD",
"minorUnits": 32000
},
"retailCost": {
"currency": "USD",
"minorUnits": 70200
},
"status": "presented"
},
{
"productType": "EWT",
"planCode": "EWT-STD",
"termMonths": 60,
"termMiles": 60000,
"dealerCost": {
"currency": "USD",
"minorUnits": 26000
},
"retailCost": {
"currency": "USD",
"minorUnits": 60100
},
"status": "presented"
},
{
"productType": "TIRE",
"planCode": "TIRE-STD",
"termMonths": 36,
"termMiles": 36000,
"dealerCost": {
"currency": "USD",
"minorUnits": 34000
},
"retailCost": {
"currency": "USD",
"minorUnits": 80300
},
"status": "presented"
},
{
"productType": "KEY",
"planCode": "KEY-STD",
"termMonths": 60,
"termMiles": 0,
"dealerCost": {
"currency": "USD",
"minorUnits": 15000
},
"retailCost": {
"currency": "USD",
"minorUnits": 39900
},
"status": "presented"
},
{
"productType": "ETCH",
"planCode": "ETCH-NEW",
"termMonths": 60,
"termMiles": 0,
"dealerCost": {
"currency": "USD",
"minorUnits": 9000
},
"retailCost": {
"currency": "USD",
"minorUnits": 30200
},
"status": "presented"
}
],
"provenance": {
"environment": "sandbox",
"simulated": true,
"provider": "fni-administrator-sandbox"
}
}
},
"evidence": {
"menu": {
"menuId": "MENU-1",
"lines": [
{
"productType": "VSC",
"planCode": "VSC-PLAT",
"termMonths": 36,
"termMiles": 36000,
"dealerCost": {
"currency": "USD",
"minorUnits": 135000
},
"retailCost": {
"currency": "USD",
"minorUnits": 221700
},
"status": "presented"
},
{
"productType": "GAP",
"planCode": "GAP-STD",
"termMonths": 60,
"termMiles": 0,
"dealerCost": {
"currency": "USD",
"minorUnits": 42500
},
"retailCost": {
"currency": "USD",
"minorUnits": 90400
},
"status": "presented"
},
{
"productType": "PPM",
"planCode": "PPM-36",
"termMonths": 36,
"termMiles": 36000,
"dealerCost": {
"currency": "USD",
"minorUnits": 32000
},
"retailCost": {
"currency": "USD",
"minorUnits": 70200
},
"status": "presented"
},
{
"productType": "EWT",
"planCode": "EWT-STD",
"termMonths": 60,
"termMiles": 60000,
"dealerCost": {
"currency": "USD",
"minorUnits": 26000
},
"retailCost": {
"currency": "USD",
"minorUnits": 60100
},
"status": "presented"
},
{
"productType": "TIRE",
"planCode": "TIRE-STD",
"termMonths": 36,
"termMiles": 36000,
"dealerCost": {
"currency": "USD",
"minorUnits": 34000
},
"retailCost": {
"currency": "USD",
"minorUnits": 80300
},
"status": "presented"
},
{
"productType": "KEY",
"planCode": "KEY-STD",
"termMonths": 60,
"termMiles": 0,
"dealerCost": {
"currency": "USD",
"minorUnits": 15000
},
"retailCost": {
"currency": "USD",
"minorUnits": 39900
},
"status": "presented"
},
{
"productType": "ETCH",
"planCode": "ETCH-NEW",
"termMonths": 60,
"termMiles": 0,
"dealerCost": {
"currency": "USD",
"minorUnits": 9000
},
"retailCost": {
"currency": "USD",
"minorUnits": 30200
},
"status": "presented"
}
],
"provenance": {
"environment": "sandbox",
"simulated": true,
"provider": "fni-administrator-sandbox"
}
}
},
"provenance": {
"simulated": true,
"environment": "sandbox",
"source": "fni-administrator-sandbox"
},
"events": [],
"meter": {
"charged": "0.00",
"posted": false
},
"connect": {
"type": "OFFER",
"kind": "connect",
"reason": "CONNECTION_ABSENT",
"portClass": "fni-administrator",
"state": "absent",
"url": "https://integrates.vin/connect/fni-administrator",
"message": "fiMenu.present is live via connection — certified, connect to activate: complete the fni-administrator link ceremony at https://integrates.vin/connect/fni-administrator. The credential vault (auth.vin) holds the token, and the same call answers simulated:false — activation is the token, never a deploy."
}
}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.
FniMenu
Schema
| Property | Type | Notes |
|---|---|---|
id | id | fni_ |
dealId | ref→Deal | — |
products | FniProduct[] | GAP|VSC|EWT |
presented | bool | — |
declined | bool | — |
selected | FniProduct[] | — |
Relationships
| From | To | Cardinality | As |
|---|---|---|---|
deal | fiMenu | 1:0..1 | protected |
Modeled
The noun drawn out — its record shape, its lifecycle, and how it is exercised end to end. 2 diagrams, rendered from the estate model.
FiMenu · Class model
FiMenu · State machine
Generated from the catalog. Every capability, answer, gate, and entity on this page is a rendered descriptor — it cannot drift from the wire.