docs.vin

stips

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

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

Identity

Nounstips
PillarCommerce (facets: 3 commerce)
Capabilities3 — 0 live · 3 sandbox · 0 declared
EntitiesStip
Doorsaggregator.vin
SDKVin.stips.* from apis.vin
Address/catalog/stips#{action} — the anchor IS the wire name minus stips.

Lifecycle

StipStipFSM: 4 states, 3 transitions — Pending · Verified · Failed · Waived. Each transition is a past-tense event on the record.

Events

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

Discover & read

verify

stips.verify · POST /stips/verify · gate human · sandbox · answers StipsVerify@1

FieldTypeRequiredNotes
subjectstringyes
requirementstringnowhich stip the verdict lands on
vinstringno
verifiedBystringnothe desk operator identity

The gate is a 403 NEEDS_HUMAN — the human verb authorize (credential: stips-desk) · supply side, routed to a named, staffed, priced terminus with a poll rail. Never a dead end. Price: not posted — see /pricing.

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

EmitsStip.verified@1 · Stip.failed@1.

the SDK — stips.verify
import { stips } from 'apis.vin'

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

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-18T15:47:09.696Z · HTTP 200
{
  "type": "OK",
  "answers": "StipsVerify@1",
  "value": {
    "id": "sub_ceb208e7",
    "dealId": "subject",
    "requirement": "proof-of-income",
    "status": "Verified",
    "verifiedBy": "stips-desk",
    "relevantFields": "last4-only"
  },
  "evidence": {
    "id": "sub_ceb208e7",
    "dealId": "subject",
    "requirement": "proof-of-income",
    "status": "Verified",
    "verifiedBy": "stips-desk",
    "relevantFields": "last4-only"
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "stips-sandbox"
  },
  "events": [
    "Stip.verified@1"
  ],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

Apply & book

submit

stips.submit · POST /stips/submit · gate key · sandbox · answers StipVerification@1

FieldTypeRequiredNotes
subjectstringyes
documentTypestringyesone of the 23-value documentType enum (PII-minimized to last-4 at schema level)
documentstringno
connectionstringnoaccount-verified evidence clears a stip without a document

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

EmitsStip.completed@1 · Stip.failed@1 · Stip.raised@1 · Stip.submitted@1 · Stip.verified@1 · Stip.waived@1.

the SDK — stips.submit
import { stips } from 'apis.vin'

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

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:10.053Z · HTTP 200
{
  "type": "OK",
  "answers": "StipVerification@1",
  "value": {
    "id": "sub_c6422ceb",
    "dealId": "subject",
    "requirement": "documenttype",
    "status": "Pending",
    "evidence": null,
    "relevantFields": "last4-only"
  },
  "evidence": {
    "id": "sub_c6422ceb",
    "dealId": "subject",
    "requirement": "documenttype",
    "status": "Pending",
    "evidence": null,
    "relevantFields": "last4-only"
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "stips-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

Authorize & resolve

waive

stips.waive · POST /stips/waive · gate human · sandbox · answers StipsWaive@1

FieldTypeRequiredNotes
subjectstringyes
requirementstringnowhich stip the verdict lands on
vinstringno
waivedBystringnothe desk operator identity

The gate is a 403 NEEDS_HUMAN — the human verb authorize (credential: stips-desk) · supply side, routed to a named, staffed, priced terminus with a poll rail. Never a dead end. Price: not posted — see /pricing.

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

EmitsStip.waived@1.

the SDK — stips.waive
import { stips } from 'apis.vin'

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

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-18T15:47:09.696Z · HTTP 200
{
  "type": "OK",
  "answers": "StipsWaive@1",
  "value": {
    "id": "sub_ceb208e7",
    "dealId": "subject",
    "requirement": "proof-of-income",
    "status": "Waived",
    "waivedBy": "stips-desk",
    "relevantFields": "last4-only"
  },
  "evidence": {
    "id": "sub_ceb208e7",
    "dealId": "subject",
    "requirement": "proof-of-income",
    "status": "Waived",
    "waivedBy": "stips-desk",
    "relevantFields": "last4-only"
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "stips-sandbox"
  },
  "events": [
    "Stip.waived@1"
  ],
  "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.

Stip

Schema

PropertyTypeNotes
ididsub_
dealIdref→Deal
requirementstring
statusenumVerified|Pending|Failed|Waived
evidenceEvidenceStatement
relevantFieldsprovenance

Relationships

FromToCardinalityAs
dealstips1:0..*gated

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