docs.vin

facilitator

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

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

Identity

Nounfacilitator
PillarServices (facets: 3 data · 6 services · 3 commerce)
Capabilities12 — 0 live · 12 sandbox · 0 declared
EntitiesParty
Doorsaggregator.vin
SDKVin.facilitator.* from apis.vin
Address/catalog/facilitator#{action} — the anchor IS the wire name minus facilitator.

Events

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

Discover & read

read

facilitator.read · GET /facilitators/read · gate none · sandbox · answers FacilitatorRead@1

FieldTypeRequiredNotes
vinstringno—

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

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await facilitator.read({"vin":"5GAEVAKW2PJ104011"})
GET /facilitators/read
curl 'https://apis.vin/facilitators/read?vin=5GAEVAKW2PJ104011'

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:11.398Z · HTTP 200
{
  "type": "OK",
  "answers": "FacilitatorRead@1",
  "value": {
    "vin": "5GAEVAKW2PJ104011",
    "noun": "facilitator",
    "asOf": "2026-08-10",
    "partyId": "ID-ff9dddc5",
    "type": "organization",
    "name": "The Estate Facilitation Desk",
    "identifiers": [
      {
        "kind": "desk",
        "value": "facilitation"
      }
    ],
    "roles": [
      {
        "role": "facilitator"
      }
    ],
    "status": "active",
    "file": {
      "registrationId": "FRG-e981508f",
      "participant": {
        "partyId": "ID-11f17424",
        "type": "person",
        "name": "Ava Good",
        "identifiers": [
          {
            "kind": "cast-key",
            "value": "ava-good"
          }
        ],
        "roles": [
          {
            "role": "customer"
          }
        ],
        "status": "active"
      },
      "credentialStatus": "credentialed",
      "subject": {
        "dealId": "DL-221641b3",
        "position": "QUOTED"
      }
    }
  },
  "evidence": {
    "vin": "5GAEVAKW2PJ104011",
    "noun": "facilitator",
    "asOf": "2026-08-10",
    "partyId": "ID-ff9dddc5",
    "type": "organization",
    "name": "The Estate Facilitation Desk",
    "identifiers": [
      {
        "kind": "desk",
        "value": "facilitation"
      }
    ],
    "roles": [
      {
        "role": "facilitator"
      }
    ],
    "status": "active",
    "file": {
      "registrationId": "FRG-e981508f",
      "participant": {
        "partyId": "ID-11f17424",
        "type": "person",
        "name": "Ava Good",
        "identifiers": [
          {
            "kind": "cast-key",
            "value": "ava-good"
          }
        ],
        "roles": [
          {
            "role": "customer"
          }
        ],
        "status": "active"
      },
      "credentialStatus": "credentialed",
      "subject": {
        "dealId": "DL-221641b3",
        "position": "QUOTED"
      }
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "desk-people-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

feeAssess

facilitator.feeAssess · POST /facilitators/fee-assess · gate offer · sandbox · answers FacilitatorFeeAssess@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) · /5GAEVAKW2PJ104011 (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 — Facilitator.failed@1 · Facilitator.feeAssessed@1.

the SDK — facilitator.feeAssess
import { facilitator } from 'apis.vin'

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

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:11.396Z · HTTP 200
{
  "type": "OK",
  "answers": "FacilitatorFeeAssess@1",
  "value": {
    "vin": "5GAEVAKW2PJ104011",
    "noun": "facilitator",
    "asOf": "2026-08-10",
    "partyId": "ID-ff9dddc5",
    "type": "organization",
    "name": "The Estate Facilitation Desk",
    "identifiers": [
      {
        "kind": "desk",
        "value": "facilitation"
      }
    ],
    "roles": [
      {
        "role": "facilitator"
      }
    ],
    "status": "active",
    "fee": {
      "amountCents": 12500,
      "currency": "USD",
      "per": "transaction"
    },
    "payer": {
      "name": "Ava Good",
      "castRow": "super-prime",
      "creditTier": "super-prime"
    }
  },
  "evidence": {
    "vin": "5GAEVAKW2PJ104011",
    "noun": "facilitator",
    "asOf": "2026-08-10",
    "partyId": "ID-ff9dddc5",
    "type": "organization",
    "name": "The Estate Facilitation Desk",
    "identifiers": [
      {
        "kind": "desk",
        "value": "facilitation"
      }
    ],
    "roles": [
      {
        "role": "facilitator"
      }
    ],
    "status": "active",
    "fee": {
      "amountCents": 12500,
      "currency": "USD",
      "per": "transaction"
    },
    "payer": {
      "name": "Ava Good",
      "castRow": "super-prime",
      "creditTier": "super-prime"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "desk-people-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

Apply & book

register

facilitator.register · POST /facilitators/register · gate offer · sandbox · answers FacilitatorRegister@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) · /5GAEVAKW2PJ104011 (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 — Facilitator.registered@1.

the SDK — facilitator.register
import { facilitator } from 'apis.vin'

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

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:11.412Z · HTTP 200
{
  "type": "OK",
  "answers": "FacilitatorRegister@1",
  "value": {
    "vin": "5GAEVAKW2PJ104011",
    "noun": "facilitator",
    "asOf": "2026-08-10",
    "partyId": "ID-ff9dddc5",
    "type": "organization",
    "name": "The Estate Facilitation Desk",
    "identifiers": [
      {
        "kind": "desk",
        "value": "facilitation"
      }
    ],
    "roles": [
      {
        "role": "facilitator"
      }
    ],
    "status": "active",
    "registration": {
      "id": "FRG-e981508f",
      "status": "registered",
      "participant": {
        "partyId": "ID-11f17424",
        "type": "person",
        "name": "Ava Good",
        "identifiers": [
          {
            "kind": "cast-key",
            "value": "ava-good"
          }
        ],
        "roles": [
          {
            "role": "customer"
          }
        ],
        "status": "active"
      },
      "registeredOn": "2026-07-11"
    }
  },
  "evidence": {
    "vin": "5GAEVAKW2PJ104011",
    "noun": "facilitator",
    "asOf": "2026-08-10",
    "partyId": "ID-ff9dddc5",
    "type": "organization",
    "name": "The Estate Facilitation Desk",
    "identifiers": [
      {
        "kind": "desk",
        "value": "facilitation"
      }
    ],
    "roles": [
      {
        "role": "facilitator"
      }
    ],
    "status": "active",
    "registration": {
      "id": "FRG-e981508f",
      "status": "registered",
      "participant": {
        "partyId": "ID-11f17424",
        "type": "person",
        "name": "Ava Good",
        "identifiers": [
          {
            "kind": "cast-key",
            "value": "ava-good"
          }
        ],
        "roles": [
          {
            "role": "customer"
          }
        ],
        "status": "active"
      },
      "registeredOn": "2026-07-11"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "desk-people-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

credential

facilitator.credential · POST /facilitators/credential · gate offer · sandbox · answers FacilitatorCredential@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) · /5GAEVAKW2PJ104011 (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 — Facilitator.credentialed@1.

the SDK — facilitator.credential
import { facilitator } from 'apis.vin'

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

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:11.388Z · HTTP 200
{
  "type": "OK",
  "answers": "FacilitatorCredential@1",
  "value": {
    "vin": "5GAEVAKW2PJ104011",
    "noun": "facilitator",
    "asOf": "2026-08-10",
    "partyId": "ID-ff9dddc5",
    "type": "organization",
    "name": "The Estate Facilitation Desk",
    "identifiers": [
      {
        "kind": "desk",
        "value": "facilitation"
      }
    ],
    "roles": [
      {
        "role": "facilitator"
      }
    ],
    "status": "active",
    "credential": {
      "id": "FCR-af22deb3",
      "status": "credentialed",
      "participant": {
        "partyId": "ID-11f17424",
        "type": "person",
        "name": "Ava Good",
        "identifiers": [
          {
            "kind": "cast-key",
            "value": "ava-good"
          }
        ],
        "roles": [
          {
            "role": "customer"
          }
        ],
        "status": "active"
      },
      "scopes": [
        "deal-escrow",
        "deal-disbursement"
      ]
    }
  },
  "evidence": {
    "vin": "5GAEVAKW2PJ104011",
    "noun": "facilitator",
    "asOf": "2026-08-10",
    "partyId": "ID-ff9dddc5",
    "type": "organization",
    "name": "The Estate Facilitation Desk",
    "identifiers": [
      {
        "kind": "desk",
        "value": "facilitation"
      }
    ],
    "roles": [
      {
        "role": "facilitator"
      }
    ],
    "status": "active",
    "credential": {
      "id": "FCR-af22deb3",
      "status": "credentialed",
      "participant": {
        "partyId": "ID-11f17424",
        "type": "person",
        "name": "Ava Good",
        "identifiers": [
          {
            "kind": "cast-key",
            "value": "ava-good"
          }
        ],
        "roles": [
          {
            "role": "customer"
          }
        ],
        "status": "active"
      },
      "scopes": [
        "deal-escrow",
        "deal-disbursement"
      ]
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "desk-people-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

commission

facilitator.commission · POST /facilitators/commission · gate offer · sandbox · answers FacilitatorCommission@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) · /5GAEVAKW2PJ104011 (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 — Facilitator.commissionPaid@1 · Facilitator.failed@1.

the SDK — facilitator.commission
import { facilitator } from 'apis.vin'

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

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:11.385Z · HTTP 200
{
  "type": "OK",
  "answers": "FacilitatorCommission@1",
  "value": {
    "vin": "5GAEVAKW2PJ104011",
    "noun": "facilitator",
    "asOf": "2026-08-10",
    "partyId": "ID-ff9dddc5",
    "type": "organization",
    "name": "The Estate Facilitation Desk",
    "identifiers": [
      {
        "kind": "desk",
        "value": "facilitation"
      }
    ],
    "roles": [
      {
        "role": "facilitator"
      }
    ],
    "status": "active",
    "commission": {
      "rateBp": 250,
      "baseCents": 2300000,
      "amountCents": 57500,
      "currency": "USD",
      "dealId": "DL-221641b3",
      "position": "QUOTED"
    }
  },
  "evidence": {
    "vin": "5GAEVAKW2PJ104011",
    "noun": "facilitator",
    "asOf": "2026-08-10",
    "partyId": "ID-ff9dddc5",
    "type": "organization",
    "name": "The Estate Facilitation Desk",
    "identifiers": [
      {
        "kind": "desk",
        "value": "facilitation"
      }
    ],
    "roles": [
      {
        "role": "facilitator"
      }
    ],
    "status": "active",
    "commission": {
      "rateBp": 250,
      "baseCents": 2300000,
      "amountCents": 57500,
      "currency": "USD",
      "dealId": "DL-221641b3",
      "position": "QUOTED"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "desk-people-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

Pay & settle

disburse

facilitator.disburse · POST /facilitators/disburse · gate offer · sandbox · answers FacilitatorDisburse@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) · /5GAEVAKW2PJ104011 (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 — Facilitator.disbursed@1 · Facilitator.failed@1.

the SDK — facilitator.disburse
import { facilitator } from 'apis.vin'

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

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:11.388Z · HTTP 200
{
  "type": "OK",
  "answers": "FacilitatorDisburse@1",
  "value": {
    "vin": "5GAEVAKW2PJ104011",
    "noun": "facilitator",
    "asOf": "2026-08-10",
    "partyId": "ID-ff9dddc5",
    "type": "organization",
    "name": "The Estate Facilitation Desk",
    "identifiers": [
      {
        "kind": "desk",
        "value": "facilitation"
      }
    ],
    "roles": [
      {
        "role": "facilitator"
      }
    ],
    "status": "active",
    "disbursement": {
      "status": "not-yet-funded",
      "dealId": "DL-221641b3",
      "position": "QUOTED"
    }
  },
  "evidence": {
    "vin": "5GAEVAKW2PJ104011",
    "noun": "facilitator",
    "asOf": "2026-08-10",
    "partyId": "ID-ff9dddc5",
    "type": "organization",
    "name": "The Estate Facilitation Desk",
    "identifiers": [
      {
        "kind": "desk",
        "value": "facilitation"
      }
    ],
    "roles": [
      {
        "role": "facilitator"
      }
    ],
    "status": "active",
    "disbursement": {
      "status": "not-yet-funded",
      "dealId": "DL-221641b3",
      "position": "QUOTED"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "desk-people-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

reconcile

facilitator.reconcile · POST /facilitators/reconcile · gate offer · sandbox · answers FacilitatorReconcile@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) · /5GAEVAKW2PJ104011 (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 — Facilitator.reconciled@1.

the SDK — facilitator.reconcile
import { facilitator } from 'apis.vin'

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

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:11.398Z · HTTP 200
{
  "type": "OK",
  "answers": "FacilitatorReconcile@1",
  "value": {
    "vin": "5GAEVAKW2PJ104011",
    "noun": "facilitator",
    "asOf": "2026-08-10",
    "partyId": "ID-ff9dddc5",
    "type": "organization",
    "name": "The Estate Facilitation Desk",
    "identifiers": [
      {
        "kind": "desk",
        "value": "facilitation"
      }
    ],
    "roles": [
      {
        "role": "facilitator"
      }
    ],
    "status": "active",
    "reconciliation": {
      "dealId": "DL-221641b3",
      "position": "QUOTED",
      "standing": "held",
      "entries": [
        {
          "entry": "deposit-held",
          "ref": "FES-7e9c852c",
          "amountCents": 50000
        }
      ],
      "heldCents": 50000,
      "movedCents": 0,
      "reconciled": true
    }
  },
  "evidence": {
    "vin": "5GAEVAKW2PJ104011",
    "noun": "facilitator",
    "asOf": "2026-08-10",
    "partyId": "ID-ff9dddc5",
    "type": "organization",
    "name": "The Estate Facilitation Desk",
    "identifiers": [
      {
        "kind": "desk",
        "value": "facilitation"
      }
    ],
    "roles": [
      {
        "role": "facilitator"
      }
    ],
    "status": "active",
    "reconciliation": {
      "dealId": "DL-221641b3",
      "position": "QUOTED",
      "standing": "held",
      "entries": [
        {
          "entry": "deposit-held",
          "ref": "FES-7e9c852c",
          "amountCents": 50000
        }
      ],
      "heldCents": 50000,
      "movedCents": 0,
      "reconciled": true
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "desk-people-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

Authorize & resolve

arbitrate

facilitator.arbitrate · POST /facilitators/arbitrate · gate offer · sandbox · answers FacilitatorArbitrate@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) · /5GAEVAKW2PJ104011 (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 — Facilitator.arbitrated@1.

the SDK — facilitator.arbitrate
import { facilitator } from 'apis.vin'

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

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:11.384Z · HTTP 200
{
  "type": "OK",
  "answers": "FacilitatorArbitrate@1",
  "value": {
    "vin": "5GAEVAKW2PJ104011",
    "noun": "facilitator",
    "asOf": "2026-08-10",
    "partyId": "ID-ff9dddc5",
    "type": "organization",
    "name": "The Estate Facilitation Desk",
    "identifiers": [
      {
        "kind": "desk",
        "value": "facilitation"
      }
    ],
    "roles": [
      {
        "role": "facilitator"
      }
    ],
    "status": "active",
    "dispute": {
      "status": "no-dispute-on-file"
    }
  },
  "evidence": {
    "vin": "5GAEVAKW2PJ104011",
    "noun": "facilitator",
    "asOf": "2026-08-10",
    "partyId": "ID-ff9dddc5",
    "type": "organization",
    "name": "The Estate Facilitation Desk",
    "identifiers": [
      {
        "kind": "desk",
        "value": "facilitation"
      }
    ],
    "roles": [
      {
        "role": "facilitator"
      }
    ],
    "status": "active",
    "dispute": {
      "status": "no-dispute-on-file"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "desk-people-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

escrowHold

facilitator.escrowHold · POST /facilitators/escrow-hold · gate offer · sandbox · answers FacilitatorEscrowHold@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) · /5GAEVAKW2PJ104011 (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 — Facilitator.escrowHeld@1.

the SDK — facilitator.escrowHold
import { facilitator } from 'apis.vin'

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

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:11.395Z · HTTP 200
{
  "type": "OK",
  "answers": "FacilitatorEscrowHold@1",
  "value": {
    "vin": "5GAEVAKW2PJ104011",
    "noun": "facilitator",
    "asOf": "2026-08-10",
    "partyId": "ID-ff9dddc5",
    "type": "organization",
    "name": "The Estate Facilitation Desk",
    "identifiers": [
      {
        "kind": "desk",
        "value": "facilitation"
      }
    ],
    "roles": [
      {
        "role": "facilitator"
      }
    ],
    "status": "active",
    "escrow": {
      "status": "held",
      "id": "FES-7e9c852c",
      "dealId": "DL-221641b3",
      "position": "QUOTED",
      "amountCents": 50000,
      "currency": "USD"
    }
  },
  "evidence": {
    "vin": "5GAEVAKW2PJ104011",
    "noun": "facilitator",
    "asOf": "2026-08-10",
    "partyId": "ID-ff9dddc5",
    "type": "organization",
    "name": "The Estate Facilitation Desk",
    "identifiers": [
      {
        "kind": "desk",
        "value": "facilitation"
      }
    ],
    "roles": [
      {
        "role": "facilitator"
      }
    ],
    "status": "active",
    "escrow": {
      "status": "held",
      "id": "FES-7e9c852c",
      "dealId": "DL-221641b3",
      "position": "QUOTED",
      "amountCents": 50000,
      "currency": "USD"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "desk-people-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

Lifecycle & state

escrowRelease

facilitator.escrowRelease · POST /facilitators/escrow-release · gate offer · sandbox · answers FacilitatorEscrowRelease@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) · /5GAEVAKW2PJ104011 (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 — Facilitator.escrowReleased@1.

the SDK — facilitator.escrowRelease
import { facilitator } from 'apis.vin'

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

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:11.396Z · HTTP 200
{
  "type": "OK",
  "answers": "FacilitatorEscrowRelease@1",
  "value": {
    "vin": "5GAEVAKW2PJ104011",
    "noun": "facilitator",
    "asOf": "2026-08-10",
    "partyId": "ID-ff9dddc5",
    "type": "organization",
    "name": "The Estate Facilitation Desk",
    "identifiers": [
      {
        "kind": "desk",
        "value": "facilitation"
      }
    ],
    "roles": [
      {
        "role": "facilitator"
      }
    ],
    "status": "active",
    "release": {
      "status": "still-held",
      "id": "FES-7e9c852c",
      "position": "QUOTED",
      "amountCents": 50000,
      "currency": "USD"
    }
  },
  "evidence": {
    "vin": "5GAEVAKW2PJ104011",
    "noun": "facilitator",
    "asOf": "2026-08-10",
    "partyId": "ID-ff9dddc5",
    "type": "organization",
    "name": "The Estate Facilitation Desk",
    "identifiers": [
      {
        "kind": "desk",
        "value": "facilitation"
      }
    ],
    "roles": [
      {
        "role": "facilitator"
      }
    ],
    "status": "active",
    "release": {
      "status": "still-held",
      "id": "FES-7e9c852c",
      "position": "QUOTED",
      "amountCents": 50000,
      "currency": "USD"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "desk-people-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

More actions

auditLog

facilitator.auditLog · GET /facilitators/audit-log · gate key · sandbox · answers FacilitatorAuditLog@1

FieldTypeRequiredNotes
vinstringno—

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

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

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:11.385Z · HTTP 200
{
  "type": "OK",
  "answers": "FacilitatorAuditLog@1",
  "value": {
    "vin": "5GAEVAKW2PJ104011",
    "noun": "facilitator",
    "asOf": "2026-08-10",
    "partyId": "ID-ff9dddc5",
    "type": "organization",
    "name": "The Estate Facilitation Desk",
    "identifiers": [
      {
        "kind": "desk",
        "value": "facilitation"
      }
    ],
    "roles": [
      {
        "role": "facilitator"
      }
    ],
    "status": "active",
    "auditLog": {
      "dealId": "DL-221641b3",
      "entries": [
        {
          "event": "deal-received",
          "dealId": "DL-221641b3"
        },
        {
          "event": "deposit-held",
          "escrowId": "FES-7e9c852c"
        }
      ],
      "count": 2
    }
  },
  "evidence": {
    "vin": "5GAEVAKW2PJ104011",
    "noun": "facilitator",
    "asOf": "2026-08-10",
    "partyId": "ID-ff9dddc5",
    "type": "organization",
    "name": "The Estate Facilitation Desk",
    "identifiers": [
      {
        "kind": "desk",
        "value": "facilitation"
      }
    ],
    "roles": [
      {
        "role": "facilitator"
      }
    ],
    "status": "active",
    "auditLog": {
      "dealId": "DL-221641b3",
      "entries": [
        {
          "event": "deal-received",
          "dealId": "DL-221641b3"
        },
        {
          "event": "deposit-held",
          "escrowId": "FES-7e9c852c"
        }
      ],
      "count": 2
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "desk-people-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

reconcileView

facilitator.reconcileView · GET /facilitators/reconcile-view · gate key · sandbox · answers FacilitatorReconcileView@1

FieldTypeRequiredNotes
vinstringno—

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

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await facilitator.reconcileView({"vin":"5GAEVAKW2PJ104011"})
GET /facilitators/reconcile-view
curl 'https://apis.vin/facilitators/reconcile-view?vin=5GAEVAKW2PJ104011'

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:11.404Z · HTTP 200
{
  "type": "OK",
  "answers": "FacilitatorReconcileView@1",
  "value": {
    "vin": "5GAEVAKW2PJ104011",
    "noun": "facilitator",
    "asOf": "2026-08-10",
    "partyId": "ID-ff9dddc5",
    "type": "organization",
    "name": "The Estate Facilitation Desk",
    "identifiers": [
      {
        "kind": "desk",
        "value": "facilitation"
      }
    ],
    "roles": [
      {
        "role": "facilitator"
      }
    ],
    "status": "active",
    "reconciliation": {
      "dealId": "DL-221641b3",
      "position": "QUOTED",
      "standing": "held",
      "entries": [
        {
          "entry": "deposit-held",
          "ref": "FES-7e9c852c",
          "amountCents": 50000
        }
      ],
      "heldCents": 50000,
      "movedCents": 0,
      "reconciled": true
    }
  },
  "evidence": {
    "vin": "5GAEVAKW2PJ104011",
    "noun": "facilitator",
    "asOf": "2026-08-10",
    "partyId": "ID-ff9dddc5",
    "type": "organization",
    "name": "The Estate Facilitation Desk",
    "identifiers": [
      {
        "kind": "desk",
        "value": "facilitation"
      }
    ],
    "roles": [
      {
        "role": "facilitator"
      }
    ],
    "status": "active",
    "reconciliation": {
      "dealId": "DL-221641b3",
      "position": "QUOTED",
      "standing": "held",
      "entries": [
        {
          "entry": "deposit-held",
          "ref": "FES-7e9c852c",
          "amountCents": 50000
        }
      ],
      "heldCents": 50000,
      "movedCents": 0,
      "reconciled": true
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "desk-people-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. One diagram, rendered from the estate model.

Facilitator · Class model

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

extraction

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

financialStatement

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

On this page

Identity
Events
Discover & read
read
feeAssess
Apply & book
register
credential
commission
Pay & settle
disburse
reconcile
Authorize & resolve
arbitrate
escrowHold
Lifecycle & state
escrowRelease
More actions
auditLog
reconcileView
Data model
Party
Modeled