docs.vin

ofac

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

ofac 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

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

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

monitor

ofac.monitor · POST /ofacs/monitor · gate key · sandbox · answers OfacMonitor@1

No input — this capability takes no request body.

Door — aggregator.vin serves this noun on its two routes: / (the landing) · /1C4AJWAG2HL742054 (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 — Ofac.monitored@1.

the SDK — ofac.monitor
import { ofac } from 'apis.vin'

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

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.945Z · HTTP 200
{
  "type": "OK",
  "answers": "OfacMonitor@1",
  "value": {
    "partyId": "ID-11f17424",
    "type": "person",
    "name": "Ava Good",
    "identifiers": [
      {
        "kind": "cast-key",
        "value": "ava-good"
      }
    ],
    "roles": [
      {
        "role": "customer"
      }
    ],
    "status": "active",
    "vin": "1HGCM82633A004352",
    "noun": "ofac",
    "asOf": "2026-08-10",
    "identityId": "ID-11f17424",
    "monitoring": {
      "status": "enrolled",
      "identityId": "ID-11f17424",
      "screen": {
        "ofac": "clear",
        "matches": [],
        "identityId": "ID-11f17424"
      }
    }
  },
  "evidence": {
    "partyId": "ID-11f17424",
    "type": "person",
    "name": "Ava Good",
    "identifiers": [
      {
        "kind": "cast-key",
        "value": "ava-good"
      }
    ],
    "roles": [
      {
        "role": "customer"
      }
    ],
    "status": "active",
    "vin": "1HGCM82633A004352",
    "noun": "ofac",
    "asOf": "2026-08-10",
    "identityId": "ID-11f17424",
    "monitoring": {
      "status": "enrolled",
      "identityId": "ID-11f17424",
      "screen": {
        "ofac": "clear",
        "matches": [],
        "identityId": "ID-11f17424"
      }
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "watch-desk-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

match

ofac.match · POST /ofacs/match · gate offer · sandbox · answers OfacMatch@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) · /1C4AJWAG2HL742054 (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 — Ofac.matched@1.

the SDK — ofac.match
import { ofac } from 'apis.vin'

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

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:14.577Z · HTTP 200
{
  "type": "OK",
  "answers": "OfacMatch@1",
  "value": {
    "partyId": "ID-11f17424",
    "type": "person",
    "name": "Ava Good",
    "identifiers": [
      {
        "kind": "cast-key",
        "value": "ava-good"
      }
    ],
    "roles": [
      {
        "role": "customer"
      }
    ],
    "status": "active",
    "vin": "1C4AJWAG2HL742054",
    "noun": "ofac",
    "asOf": "2026-08-10",
    "identityId": "ID-11f17424",
    "match": {
      "status": "no-match",
      "matches": [],
      "ofac": "clear",
      "identityId": "ID-11f17424"
    }
  },
  "evidence": {
    "partyId": "ID-11f17424",
    "type": "person",
    "name": "Ava Good",
    "identifiers": [
      {
        "kind": "cast-key",
        "value": "ava-good"
      }
    ],
    "roles": [
      {
        "role": "customer"
      }
    ],
    "status": "active",
    "vin": "1C4AJWAG2HL742054",
    "noun": "ofac",
    "asOf": "2026-08-10",
    "identityId": "ID-11f17424",
    "match": {
      "status": "no-match",
      "matches": [],
      "ofac": "clear",
      "identityId": "ID-11f17424"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "watch-desk-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

Authorize & resolve

clear

ofac.clear · POST /ofacs/clear · gate offer · sandbox · answers OfacClear@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) · /1C4AJWAG2HL742054 (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 — Ofac.cleared@1.

the SDK — ofac.clear
import { ofac } from 'apis.vin'

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

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:14.574Z · HTTP 200
{
  "type": "OK",
  "answers": "OfacClear@1",
  "value": {
    "partyId": "ID-11f17424",
    "type": "person",
    "name": "Ava Good",
    "identifiers": [
      {
        "kind": "cast-key",
        "value": "ava-good"
      }
    ],
    "roles": [
      {
        "role": "customer"
      }
    ],
    "status": "active",
    "vin": "1C4AJWAG2HL742054",
    "noun": "ofac",
    "asOf": "2026-08-10",
    "identityId": "ID-11f17424",
    "clearance": {
      "status": "already-clear",
      "ofac": "clear",
      "identityId": "ID-11f17424"
    }
  },
  "evidence": {
    "partyId": "ID-11f17424",
    "type": "person",
    "name": "Ava Good",
    "identifiers": [
      {
        "kind": "cast-key",
        "value": "ava-good"
      }
    ],
    "roles": [
      {
        "role": "customer"
      }
    ],
    "status": "active",
    "vin": "1C4AJWAG2HL742054",
    "noun": "ofac",
    "asOf": "2026-08-10",
    "identityId": "ID-11f17424",
    "clearance": {
      "status": "already-clear",
      "ofac": "clear",
      "identityId": "ID-11f17424"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "watch-desk-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

More actions

block

ofac.block · POST /ofacs/block · gate offer · sandbox · answers OfacBlock@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) · /1C4AJWAG2HL742054 (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 — Ofac.blocked@1.

the SDK — ofac.block
import { ofac } from 'apis.vin'

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

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:14.574Z · HTTP 200
{
  "type": "OK",
  "answers": "OfacBlock@1",
  "value": {
    "partyId": "ID-11f17424",
    "type": "person",
    "name": "Ava Good",
    "identifiers": [
      {
        "kind": "cast-key",
        "value": "ava-good"
      }
    ],
    "roles": [
      {
        "role": "customer"
      }
    ],
    "status": "active",
    "vin": "1C4AJWAG2HL742054",
    "noun": "ofac",
    "asOf": "2026-08-10",
    "identityId": "ID-11f17424",
    "blocking": {
      "status": "nothing-to-block",
      "basis": "no-watchlist-match",
      "ofac": "clear",
      "identityId": "ID-11f17424"
    }
  },
  "evidence": {
    "partyId": "ID-11f17424",
    "type": "person",
    "name": "Ava Good",
    "identifiers": [
      {
        "kind": "cast-key",
        "value": "ava-good"
      }
    ],
    "roles": [
      {
        "role": "customer"
      }
    ],
    "status": "active",
    "vin": "1C4AJWAG2HL742054",
    "noun": "ofac",
    "asOf": "2026-08-10",
    "identityId": "ID-11f17424",
    "blocking": {
      "status": "nothing-to-block",
      "basis": "no-watchlist-match",
      "ofac": "clear",
      "identityId": "ID-11f17424"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "watch-desk-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

log

ofac.log · GET /ofacs/log · gate key · sandbox · answers OfacLog@1

FieldTypeRequiredNotes
vinstringno—

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

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await ofac.log({"vin":"1C4AJWAG2HL742054"})
GET /ofacs/log
curl 'https://apis.vin/ofacs/log?vin=1C4AJWAG2HL742054'

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:14.574Z · HTTP 200
{
  "type": "OK",
  "answers": "OfacLog@1",
  "value": {
    "partyId": "ID-11f17424",
    "type": "person",
    "name": "Ava Good",
    "identifiers": [
      {
        "kind": "cast-key",
        "value": "ava-good"
      }
    ],
    "roles": [
      {
        "role": "customer"
      }
    ],
    "status": "active",
    "vin": "1C4AJWAG2HL742054",
    "noun": "ofac",
    "asOf": "2026-08-10",
    "identityId": "ID-11f17424",
    "log": {
      "identityId": "ID-11f17424",
      "entries": [
        {
          "date": "2026-04-12",
          "kind": "ofac-screened",
          "screen": {
            "ofac": "clear",
            "matches": [],
            "identityId": "ID-11f17424"
          }
        }
      ]
    }
  },
  "evidence": {
    "partyId": "ID-11f17424",
    "type": "person",
    "name": "Ava Good",
    "identifiers": [
      {
        "kind": "cast-key",
        "value": "ava-good"
      }
    ],
    "roles": [
      {
        "role": "customer"
      }
    ],
    "status": "active",
    "vin": "1C4AJWAG2HL742054",
    "noun": "ofac",
    "asOf": "2026-08-10",
    "identityId": "ID-11f17424",
    "log": {
      "identityId": "ID-11f17424",
      "entries": [
        {
          "date": "2026-04-12",
          "kind": "ofac-screened",
          "screen": {
            "ofac": "clear",
            "matches": [],
            "identityId": "ID-11f17424"
          }
        }
      ]
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "watch-desk-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

screen

ofac.screen · POST /ofacs/screen · gate offer · sandbox · answers OfacScreen@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) · /1C4AJWAG2HL742054 (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 — Ofac.requested@1 · Ofac.screened@1.

the SDK — ofac.screen
import { ofac } from 'apis.vin'

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

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:14.577Z · HTTP 200
{
  "type": "OK",
  "answers": "OfacScreen@1",
  "value": {
    "partyId": "ID-11f17424",
    "type": "person",
    "name": "Ava Good",
    "identifiers": [
      {
        "kind": "cast-key",
        "value": "ava-good"
      }
    ],
    "roles": [
      {
        "role": "customer"
      }
    ],
    "status": "active",
    "vin": "1C4AJWAG2HL742054",
    "noun": "ofac",
    "asOf": "2026-08-10",
    "identityId": "ID-11f17424",
    "screen": {
      "ofac": "clear",
      "matches": [],
      "identityId": "ID-11f17424"
    }
  },
  "evidence": {
    "partyId": "ID-11f17424",
    "type": "person",
    "name": "Ava Good",
    "identifiers": [
      {
        "kind": "cast-key",
        "value": "ava-good"
      }
    ],
    "roles": [
      {
        "role": "customer"
      }
    ],
    "status": "active",
    "vin": "1C4AJWAG2HL742054",
    "noun": "ofac",
    "asOf": "2026-08-10",
    "identityId": "ID-11f17424",
    "screen": {
      "ofac": "clear",
      "matches": [],
      "identityId": "ID-11f17424"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "watch-desk-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.

Party

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.

Ofac · Class model

Ofac · State machine

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

notary

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

offer

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

On this page

Identity
Events
Discover & read
monitor
match
Authorize & resolve
clear
More actions
block
log
screen
Data model
Party
Modeled