docs.vin

credit

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

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

Identity

Nouncredit
PillarCommerce (facets: 2 commerce)
Capabilities2 — 0 live · 2 sandbox · 0 declared
EntitiesCreditApplication
Doorsfinancing.vin
SDKVin.credit.* from apis.vin
Address/catalog/credit#{action} — the anchor IS the wire name minus credit.

Events

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

Apply & book

apply

credit.apply · POST /credits/apply · gate offer · sandbox · answers CreditApplication@1

FieldTypeRequiredNotes
applicantobjectyes
coApplicantobjectno
residenceobjectno
employmentobjectno
financeSourcestringyeslender id (abstract)
fromPreapprovalstringno
subjectstringno
consentobjectnoFCRA/GLB permissible-purpose consent triple

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.

Delegated calls require a typed Mandate{ ceiling, perAction, expires, tripwires }; the ceiling is a field, not a conversation.

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

EmitsCreditApplication.conditioned@1 · CreditApplication.decisioned@1 · CreditApplication.declined@1 · CreditApplication.submitted@1.

the SDK — credit.apply
import { credit } from 'apis.vin'

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

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.732Z · HTTP 200
{
  "type": "OK",
  "answers": "CreditApplication@1",
  "value": {
    "type": "BLOCKED",
    "reason": "FCRA consent evidence is required before a bureau pull"
  },
  "evidence": {
    "type": "BLOCKED",
    "reason": "FCRA consent evidence is required before a bureau pull"
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "credit-bureau-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  },
  "connect": {
    "type": "OFFER",
    "kind": "connect",
    "reason": "CONNECTION_ABSENT",
    "portClass": "lender-network",
    "state": "absent",
    "url": "https://integrates.vin/connect/lender-network",
    "message": "credit.apply is live via connection — certified, connect to activate: complete the lender-network link ceremony at https://integrates.vin/connect/lender-network. The credential vault (auth.vin) holds the token, and the same call answers simulated:false — activation is the token, never a deploy."
  }
}

More actions

prequal

credit.prequal · POST /credits/prequal · gate key · sandbox · answers PreApproval@1

FieldTypeRequiredNotes
applicantobjectyes
vinstringno
consentobjectno

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

EmitsPreApproval.expired@1 · PreApproval.issued@1 · PreApproval.infoNeeded@1.

the SDK — credit.prequal
import { credit } from 'apis.vin'

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

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:09.893Z · HTTP 200
{
  "type": "OK",
  "answers": "PreApproval@1",
  "value": {
    "type": "BLOCKED",
    "reason": "FCRA consent evidence is required before a bureau pull"
  },
  "evidence": {
    "type": "BLOCKED",
    "reason": "FCRA consent evidence is required before a bureau pull"
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "credit-bureau-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  },
  "connect": {
    "type": "OFFER",
    "kind": "connect",
    "reason": "CONNECTION_ABSENT",
    "portClass": "credit-bureau",
    "state": "absent",
    "url": "https://integrates.vin/connect/credit-bureau",
    "message": "credit.prequal is live via connection — certified, connect to activate: complete the credit-bureau link ceremony at https://integrates.vin/connect/credit-bureau. 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.

CreditApplication

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.

Credit · Class model

Credit · Sequence


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