docs.vin

adverseAction

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

adverseAction 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

NounadverseAction
PillarServices (facets: 2 data · 4 services)
Capabilities6 — 0 live · 6 sandbox · 0 declared
EntitiesCreditApplication
Doorsaggregator.vin
SDKVin.adverseAction.* from apis.vin
Address/catalog/adverseAction#{action} — the anchor IS the wire name minus adverseAction.

Events

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

Discover & read

audit

adverseAction.audit · GET /adverse-actions/audit · gate key · sandbox · answers AdverseActionAudit@1

FieldTypeRequiredNotes
vinstringno

Dooraggregator.vin serves this noun on its two routes: / (the landing) · /5N1DR3CD3SC256217 (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 — adverseAction.audit
import { adverseAction } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await adverseAction.audit({"vin":"5N1DR3CD3SC256217"})
GET /adverse-actions/audit
curl 'https://apis.vin/adverse-actions/audit?vin=5N1DR3CD3SC256217'

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:07.149Z · HTTP 200
{
  "type": "OK",
  "answers": "AdverseActionAudit@1",
  "value": {
    "vin": "5N1DR3CD3SC256217",
    "noun": "adverseAction",
    "asOf": "2026-08-10",
    "id": "app_0721a668",
    "applicantId": "ID-11f17424",
    "coApplicants": [],
    "lenderId": "F00SET",
    "decision": {
      "status": "pending"
    },
    "stips": [],
    "adverseAction": {
      "status": "none"
    },
    "status": "Prequal",
    "audit": {
      "adverseAction": {
        "status": "none"
      },
      "entries": [],
      "count": 0
    }
  },
  "evidence": {
    "vin": "5N1DR3CD3SC256217",
    "noun": "adverseAction",
    "asOf": "2026-08-10",
    "id": "app_0721a668",
    "applicantId": "ID-11f17424",
    "coApplicants": [],
    "lenderId": "F00SET",
    "decision": {
      "status": "pending"
    },
    "stips": [],
    "adverseAction": {
      "status": "none"
    },
    "status": "Prequal",
    "audit": {
      "adverseAction": {
        "status": "none"
      },
      "entries": [],
      "count": 0
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "credit-jacket-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

Fulfill & operate

deliver

adverseAction.deliver · POST /adverse-actions/deliver · gate offer · sandbox · answers AdverseActionDeliver@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.

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

EmitsAdverseAction.delivered@1.

the SDK — adverseAction.deliver
import { adverseAction } from 'apis.vin'

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

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:07.149Z · HTTP 200
{
  "type": "OK",
  "answers": "AdverseActionDeliver@1",
  "value": {
    "vin": "5N1DR3CD3SC256217",
    "noun": "adverseAction",
    "asOf": "2026-08-10",
    "id": "app_0721a668",
    "applicantId": "ID-11f17424",
    "coApplicants": [],
    "lenderId": "F00SET",
    "decision": {
      "status": "pending"
    },
    "stips": [],
    "adverseAction": {
      "status": "none"
    },
    "status": "Prequal",
    "delivery": {
      "status": "no-notice-to-deliver",
      "position": "Prequal"
    }
  },
  "evidence": {
    "vin": "5N1DR3CD3SC256217",
    "noun": "adverseAction",
    "asOf": "2026-08-10",
    "id": "app_0721a668",
    "applicantId": "ID-11f17424",
    "coApplicants": [],
    "lenderId": "F00SET",
    "decision": {
      "status": "pending"
    },
    "stips": [],
    "adverseAction": {
      "status": "none"
    },
    "status": "Prequal",
    "delivery": {
      "status": "no-notice-to-deliver",
      "position": "Prequal"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "credit-jacket-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

More actions

determine

adverseAction.determine · GET /adverse-actions/determine · gate key · sandbox · answers AdverseActionDetermine@1

FieldTypeRequiredNotes
vinstringno

Dooraggregator.vin serves this noun on its two routes: / (the landing) · /5N1DR3CD3SC256217 (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 — adverseAction.determine
import { adverseAction } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await adverseAction.determine({"vin":"5N1DR3CD3SC256217"})
GET /adverse-actions/determine
curl 'https://apis.vin/adverse-actions/determine?vin=5N1DR3CD3SC256217'

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:07.149Z · HTTP 200
{
  "type": "OK",
  "answers": "AdverseActionDetermine@1",
  "value": {
    "vin": "5N1DR3CD3SC256217",
    "noun": "adverseAction",
    "asOf": "2026-08-10",
    "id": "app_0721a668",
    "applicantId": "ID-11f17424",
    "coApplicants": [],
    "lenderId": "F00SET",
    "decision": {
      "status": "pending"
    },
    "stips": [],
    "adverseAction": {
      "status": "none"
    },
    "status": "Prequal",
    "determination": {
      "decision": {
        "status": "pending"
      },
      "adverse": false,
      "position": "Prequal",
      "basis": "one-decision-derivation"
    }
  },
  "evidence": {
    "vin": "5N1DR3CD3SC256217",
    "noun": "adverseAction",
    "asOf": "2026-08-10",
    "id": "app_0721a668",
    "applicantId": "ID-11f17424",
    "coApplicants": [],
    "lenderId": "F00SET",
    "decision": {
      "status": "pending"
    },
    "stips": [],
    "adverseAction": {
      "status": "none"
    },
    "status": "Prequal",
    "determination": {
      "decision": {
        "status": "pending"
      },
      "adverse": false,
      "position": "Prequal",
      "basis": "one-decision-derivation"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "credit-jacket-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

notice

adverseAction.notice · POST /adverse-actions/notice · gate offer · sandbox · answers AdverseActionNotice@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.

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

EmitsAdverseAction.noticeIssued@1.

the SDK — adverseAction.notice
import { adverseAction } from 'apis.vin'

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

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:07.153Z · HTTP 200
{
  "type": "OK",
  "answers": "AdverseActionNotice@1",
  "value": {
    "vin": "5N1DR3CD3SC256217",
    "noticeRef": "AAN-0017",
    "decision": "declined",
    "principalReasons": [
      "insufficient-credit-history",
      "debt-to-income-ratio"
    ],
    "creditScoreDisclosed": true,
    "scoreRange": {
      "low": 300,
      "high": 850
    },
    "furnisherDisclosureIncluded": true,
    "deliveryDeadlineDays": 30,
    "compliant": true,
    "asOf": "2026-08-10"
  },
  "evidence": {
    "vin": "5N1DR3CD3SC256217",
    "noticeRef": "AAN-0017",
    "decision": "declined",
    "principalReasons": [
      "insufficient-credit-history",
      "debt-to-income-ratio"
    ],
    "creditScoreDisclosed": true,
    "scoreRange": {
      "low": 300,
      "high": 850
    },
    "furnisherDisclosureIncluded": true,
    "deliveryDeadlineDays": 30,
    "compliant": true,
    "asOf": "2026-08-10"
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "legal-authority-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

reasons

adverseAction.reasons · POST /adverse-actions/reasons · gate offer · sandbox · answers AdverseActionReasons@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.

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

EmitsAdverseAction.reasonsAssembled@1.

the SDK — adverseAction.reasons
import { adverseAction } from 'apis.vin'

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

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:07.153Z · HTTP 200
{
  "type": "OK",
  "answers": "AdverseActionReasons@1",
  "value": {
    "vin": "5N1DR3CD3SC256217",
    "noun": "adverseAction",
    "asOf": "2026-08-10",
    "id": "app_0721a668",
    "applicantId": "ID-11f17424",
    "coApplicants": [],
    "lenderId": "F00SET",
    "decision": {
      "status": "pending"
    },
    "stips": [],
    "adverseAction": {
      "status": "none"
    },
    "status": "Prequal",
    "reasons": {
      "status": "no-adverse-action",
      "position": "Prequal"
    }
  },
  "evidence": {
    "vin": "5N1DR3CD3SC256217",
    "noun": "adverseAction",
    "asOf": "2026-08-10",
    "id": "app_0721a668",
    "applicantId": "ID-11f17424",
    "coApplicants": [],
    "lenderId": "F00SET",
    "decision": {
      "status": "pending"
    },
    "stips": [],
    "adverseAction": {
      "status": "none"
    },
    "status": "Prequal",
    "reasons": {
      "status": "no-adverse-action",
      "position": "Prequal"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "credit-jacket-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

riskBasedPricing

adverseAction.riskBasedPricing · POST /adverse-actions/risk-based-pricing · gate offer · sandbox · answers AdverseActionRiskBasedPricing@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.

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

EmitsAdverseAction.rbpNoticed@1.

the SDK — adverseAction.riskBasedPricing
import { adverseAction } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await adverseAction.riskBasedPricing({"vin":"5N1DR3CD3SC256217"})
POST /adverse-actions/risk-based-pricing
curl -X POST https://apis.vin/adverse-actions/risk-based-pricing \
  -H 'content-type: application/json' \
  -d '{"vin":"5N1DR3CD3SC256217"}'

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:07.157Z · HTTP 200
{
  "type": "OK",
  "answers": "AdverseActionRiskBasedPricing@1",
  "value": {
    "vin": "5N1DR3CD3SC256217",
    "noun": "adverseAction",
    "asOf": "2026-08-10",
    "id": "app_0721a668",
    "applicantId": "ID-11f17424",
    "coApplicants": [],
    "lenderId": "F00SET",
    "decision": {
      "status": "pending"
    },
    "stips": [],
    "adverseAction": {
      "status": "none"
    },
    "status": "Prequal",
    "rbp": {
      "status": "not-required",
      "band": "best"
    }
  },
  "evidence": {
    "vin": "5N1DR3CD3SC256217",
    "noun": "adverseAction",
    "asOf": "2026-08-10",
    "id": "app_0721a668",
    "applicantId": "ID-11f17424",
    "coApplicants": [],
    "lenderId": "F00SET",
    "decision": {
      "status": "pending"
    },
    "stips": [],
    "adverseAction": {
      "status": "none"
    },
    "status": "Prequal",
    "rbp": {
      "status": "not-required",
      "band": "best"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "credit-jacket-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.

CreditApplication


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