docs.vin

disclosureBundle

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

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

Identity

NoundisclosureBundle
PillarServices (facets: 1 data · 5 services)
Capabilities6 — 0 live · 6 sandbox · 0 declared
EntitiesDealJacket
Doorsaggregator.vin
SDKVin.disclosureBundle.* from apis.vin
Address/catalog/disclosureBundle#{action} — the anchor IS the wire name minus disclosureBundle.

Events

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

Discover & read

validate

disclosureBundle.validate · POST /disclosure-bundles/validate · gate offer · sandbox · answers DisclosureBundleValidate@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) · /1FMCU9MN8SUA28468 (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 — DisclosureBundle.validated@1.

the SDK — disclosureBundle.validate
import { disclosureBundle } from 'apis.vin'

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

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:10.423Z · HTTP 200
{
  "type": "OK",
  "answers": "DisclosureBundleValidate@1",
  "value": {
    "vin": "1FMCU9MN8SUA28468",
    "noun": "disclosureBundle",
    "asOf": "2026-08-10",
    "id": "DJK-fb48aefa",
    "dealId": "DL-01919f7c",
    "documents": [
      "DOC-fb417fd1"
    ],
    "complete": false,
    "validation": {
      "bundleId": "DSB-9d8d6449",
      "status": "incomplete",
      "openItems": [
        "credit-approved",
        "documents-signed",
        "contract-signed",
        "funds-settled"
      ]
    }
  },
  "evidence": {
    "vin": "1FMCU9MN8SUA28468",
    "noun": "disclosureBundle",
    "asOf": "2026-08-10",
    "id": "DJK-fb48aefa",
    "dealId": "DL-01919f7c",
    "documents": [
      "DOC-fb417fd1"
    ],
    "complete": false,
    "validation": {
      "bundleId": "DSB-9d8d6449",
      "status": "incomplete",
      "openItems": [
        "credit-approved",
        "documents-signed",
        "contract-signed",
        "funds-settled"
      ]
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "closing-papers-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

audit

disclosureBundle.audit · GET /disclosure-bundles/audit · gate key · sandbox · answers DisclosureBundleAudit@1

FieldTypeRequiredNotes
vinstringno—

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

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await disclosureBundle.audit({"vin":"1FMCU9MN8SUA28468"})
GET /disclosure-bundles/audit
curl 'https://apis.vin/disclosure-bundles/audit?vin=1FMCU9MN8SUA28468'

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:10.402Z · HTTP 200
{
  "type": "OK",
  "answers": "DisclosureBundleAudit@1",
  "value": {
    "vin": "1FMCU9MN8SUA28468",
    "noun": "disclosureBundle",
    "asOf": "2026-08-10",
    "id": "DJK-fb48aefa",
    "dealId": "DL-01919f7c",
    "documents": [
      "DOC-fb417fd1"
    ],
    "complete": false,
    "audit": {
      "bundleId": "DSB-9d8d6449",
      "entries": [
        {
          "event": "jacket-opened",
          "jacketId": "DJK-fb48aefa",
          "dealId": "DL-01919f7c"
        }
      ],
      "count": 1
    }
  },
  "evidence": {
    "vin": "1FMCU9MN8SUA28468",
    "noun": "disclosureBundle",
    "asOf": "2026-08-10",
    "id": "DJK-fb48aefa",
    "dealId": "DL-01919f7c",
    "documents": [
      "DOC-fb417fd1"
    ],
    "complete": false,
    "audit": {
      "bundleId": "DSB-9d8d6449",
      "entries": [
        {
          "event": "jacket-opened",
          "jacketId": "DJK-fb48aefa",
          "dealId": "DL-01919f7c"
        }
      ],
      "count": 1
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "closing-papers-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

Fulfill & operate

assemble

disclosureBundle.assemble · POST /disclosure-bundles/assemble · gate offer · sandbox · answers DisclosureBundleAssemble@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) · /1FMCU9MN8SUA28468 (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 — DisclosureBundle.assembled@1.

the SDK — disclosureBundle.assemble
import { disclosureBundle } from 'apis.vin'

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

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:10.401Z · HTTP 200
{
  "type": "OK",
  "answers": "DisclosureBundleAssemble@1",
  "value": {
    "vin": "1FMCU9MN8SUA28468",
    "noun": "disclosureBundle",
    "asOf": "2026-08-10",
    "id": "DJK-fb48aefa",
    "dealId": "DL-01919f7c",
    "documents": [
      "DOC-fb417fd1"
    ],
    "complete": false,
    "bundle": {
      "id": "DSB-9d8d6449",
      "jacketId": "DJK-fb48aefa",
      "forms": [
        "tila",
        "ecoa",
        "state-disclosures"
      ],
      "documents": [
        "DOC-fb417fd1"
      ],
      "status": "assembled"
    }
  },
  "evidence": {
    "vin": "1FMCU9MN8SUA28468",
    "noun": "disclosureBundle",
    "asOf": "2026-08-10",
    "id": "DJK-fb48aefa",
    "dealId": "DL-01919f7c",
    "documents": [
      "DOC-fb417fd1"
    ],
    "complete": false,
    "bundle": {
      "id": "DSB-9d8d6449",
      "jacketId": "DJK-fb48aefa",
      "forms": [
        "tila",
        "ecoa",
        "state-disclosures"
      ],
      "documents": [
        "DOC-fb417fd1"
      ],
      "status": "assembled"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "closing-papers-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

Authorize & resolve

eSign

disclosureBundle.eSign · POST /disclosure-bundles/e-sign · gate offer · sandbox · answers DisclosureBundleESign@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) · /1FMCU9MN8SUA28468 (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 — DisclosureBundle.eSigned@1.

the SDK — disclosureBundle.eSign
import { disclosureBundle } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await disclosureBundle.eSign({"vin":"1FMCU9MN8SUA28468"})
POST /disclosure-bundles/e-sign
curl -X POST https://apis.vin/disclosure-bundles/e-sign \
  -H 'content-type: application/json' \
  -d '{"vin":"1FMCU9MN8SUA28468"}'

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:10.415Z · HTTP 200
{
  "type": "OK",
  "answers": "DisclosureBundleESign@1",
  "value": {
    "vin": "1FMCU9MN8SUA28468",
    "noun": "disclosureBundle",
    "asOf": "2026-08-10",
    "id": "DJK-fb48aefa",
    "dealId": "DL-01919f7c",
    "documents": [
      "DOC-fb417fd1"
    ],
    "complete": false,
    "esign": {
      "bundleId": "DSB-9d8d6449",
      "status": "awaiting-signature",
      "documentId": "DOC-fb417fd1",
      "position": "Draft"
    }
  },
  "evidence": {
    "vin": "1FMCU9MN8SUA28468",
    "noun": "disclosureBundle",
    "asOf": "2026-08-10",
    "id": "DJK-fb48aefa",
    "dealId": "DL-01919f7c",
    "documents": [
      "DOC-fb417fd1"
    ],
    "complete": false,
    "esign": {
      "bundleId": "DSB-9d8d6449",
      "status": "awaiting-signature",
      "documentId": "DOC-fb417fd1",
      "position": "Draft"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "closing-papers-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

More actions

rescission

disclosureBundle.rescission · POST /disclosure-bundles/rescission · gate offer · sandbox · answers DisclosureBundleRescission@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) · /1FMCU9MN8SUA28468 (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 — DisclosureBundle.rescinded@1.

the SDK — disclosureBundle.rescission
import { disclosureBundle } from 'apis.vin'

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

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:10.416Z · HTTP 200
{
  "type": "OK",
  "answers": "DisclosureBundleRescission@1",
  "value": {
    "vin": "1FMCU9MN8SUA28468",
    "noun": "disclosureBundle",
    "asOf": "2026-08-10",
    "id": "DJK-fb48aefa",
    "dealId": "DL-01919f7c",
    "documents": [
      "DOC-fb417fd1"
    ],
    "complete": false,
    "rescission": {
      "status": "nothing-contracted-to-rescind",
      "id": "DL-01919f7c",
      "position": "QUOTED"
    }
  },
  "evidence": {
    "vin": "1FMCU9MN8SUA28468",
    "noun": "disclosureBundle",
    "asOf": "2026-08-10",
    "id": "DJK-fb48aefa",
    "dealId": "DL-01919f7c",
    "documents": [
      "DOC-fb417fd1"
    ],
    "complete": false,
    "rescission": {
      "status": "nothing-contracted-to-rescind",
      "id": "DL-01919f7c",
      "position": "QUOTED"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "closing-papers-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

retain

disclosureBundle.retain · POST /disclosure-bundles/retain · gate offer · sandbox · answers DisclosureBundleRetain@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) · /1FMCU9MN8SUA28468 (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 — DisclosureBundle.retained@1.

the SDK — disclosureBundle.retain
import { disclosureBundle } from 'apis.vin'

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

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:10.416Z · HTTP 200
{
  "type": "OK",
  "answers": "DisclosureBundleRetain@1",
  "value": {
    "vin": "1FMCU9MN8SUA28468",
    "noun": "disclosureBundle",
    "asOf": "2026-08-10",
    "id": "DJK-fb48aefa",
    "dealId": "DL-01919f7c",
    "documents": [
      "DOC-fb417fd1"
    ],
    "complete": false,
    "retention": {
      "documentId": "DOC-fb417fd1",
      "policy": "deal-paper-7y",
      "retainUntil": "2033-08-08"
    }
  },
  "evidence": {
    "vin": "1FMCU9MN8SUA28468",
    "noun": "disclosureBundle",
    "asOf": "2026-08-10",
    "id": "DJK-fb48aefa",
    "dealId": "DL-01919f7c",
    "documents": [
      "DOC-fb417fd1"
    ],
    "complete": false,
    "retention": {
      "documentId": "DOC-fb417fd1",
      "policy": "deal-paper-7y",
      "retainUntil": "2033-08-08"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "closing-papers-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.

DealJacket

Modeled

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

DisclosureBundle · Class model

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

disabledPlacard

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

disposition

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

On this page

Identity
Events
Discover & read
validate
audit
Fulfill & operate
assemble
Authorize & resolve
eSign
More actions
rescission
retain
Data model
DealJacket
Modeled