docs.vin

extraction

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

extraction 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 docs.vin.

Identity

Nounextraction
PillarServices (facets: 1 services)
Capabilities1 — 0 live · 1 sandbox · 0 declared
EntitiesDocument
Doorsdocs.vin
SDKVin.extraction.* from apis.vin
Address/catalog/extraction#{action} — the anchor IS the wire name minus extraction.

Events

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

More actions

extract

extraction.extract · POST /extractions/extract · gate offer · sandbox · answers ExtractedTerms@1

FieldTypeRequiredNotes
filestringyesphoto/PDF
expectstringnoone of drivers-license, signed-contract, payoff-letter, insurance-card, title, odometer

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.

Doordocs.vin serves this noun on its two routes: / (the landing) · /1C6SRFHP7SN674999 (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.

EmitsDocument.extracted@1.

the SDK — extraction.extract
import { extraction } from 'apis.vin'

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

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.814Z · HTTP 200
{
  "type": "OK",
  "answers": "ExtractedTerms@1",
  "value": {
    "vin": "1HGCM82633A004352",
    "noun": "extraction",
    "asOf": "2026-08-10",
    "document": {
      "status": "no-document-on-file"
    },
    "extraction": {
      "id": "DOC-b22c1bcf",
      "vin": "1HGCM82633A004352",
      "buyer": "Ava Good",
      "priceCents": 499500,
      "currency": "USD",
      "status": "extracted"
    }
  },
  "evidence": {
    "vin": "1HGCM82633A004352",
    "noun": "extraction",
    "asOf": "2026-08-10",
    "document": {
      "status": "no-document-on-file"
    },
    "extraction": {
      "id": "DOC-b22c1bcf",
      "vin": "1HGCM82633A004352",
      "buyer": "Ava Good",
      "priceCents": 499500,
      "currency": "USD",
      "status": "extracted"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "paper-annex-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.

Document


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