docs.vin

foreignId

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

foreignId 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

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

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

visaStatusCheck

foreignId.visaStatusCheck · GET /foreign-ids/visa-status-check · gate none · sandbox · answers ForeignIdVisaStatusCheck@1

No input — this capability takes no request body.

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

the SDK — foreignId.visaStatusCheck
import { foreignId } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await foreignId.visaStatusCheck()
GET /foreign-ids/visa-status-check
curl 'https://apis.vin/foreign-ids/visa-status-check'

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.838Z · HTTP 200
{
  "type": "OK",
  "answers": "ForeignIdVisaStatusCheck@1",
  "value": {
    "vin": "1HGCM82633A004352",
    "noun": "foreignId",
    "asOf": "2026-08-10",
    "application": {
      "status": "no-application-on-file"
    },
    "verification": {
      "kind": "visa-status",
      "status": "verified",
      "participant": {
        "partyId": "ID-11f17424",
        "type": "person",
        "name": "Ava Good",
        "identifiers": [
          {
            "kind": "cast-key",
            "value": "ava-good"
          }
        ],
        "roles": [
          {
            "role": "customer"
          }
        ],
        "status": "active"
      }
    }
  },
  "evidence": {
    "vin": "1HGCM82633A004352",
    "noun": "foreignId",
    "asOf": "2026-08-10",
    "application": {
      "status": "no-application-on-file"
    },
    "verification": {
      "kind": "visa-status",
      "status": "verified",
      "participant": {
        "partyId": "ID-11f17424",
        "type": "person",
        "name": "Ava Good",
        "identifiers": [
          {
            "kind": "cast-key",
            "value": "ava-good"
          }
        ],
        "roles": [
          {
            "role": "customer"
          }
        ],
        "status": "active"
      }
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "credit-jacket-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

foreignLicenseVerify

foreignId.foreignLicenseVerify · GET /foreign-ids/foreign-license-verify · gate none · sandbox · answers ForeignIdForeignLicenseVerify@1

No input — this capability takes no request body.

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

the SDK — foreignId.foreignLicenseVerify
import { foreignId } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await foreignId.foreignLicenseVerify()
GET /foreign-ids/foreign-license-verify
curl 'https://apis.vin/foreign-ids/foreign-license-verify'

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.837Z · HTTP 200
{
  "type": "OK",
  "answers": "ForeignIdForeignLicenseVerify@1",
  "value": {
    "vin": "1HGCM82633A004352",
    "noun": "foreignId",
    "asOf": "2026-08-10",
    "application": {
      "status": "no-application-on-file"
    },
    "verification": {
      "kind": "foreign-license",
      "status": "verified",
      "participant": {
        "partyId": "ID-11f17424",
        "type": "person",
        "name": "Ava Good",
        "identifiers": [
          {
            "kind": "cast-key",
            "value": "ava-good"
          }
        ],
        "roles": [
          {
            "role": "customer"
          }
        ],
        "status": "active"
      }
    }
  },
  "evidence": {
    "vin": "1HGCM82633A004352",
    "noun": "foreignId",
    "asOf": "2026-08-10",
    "application": {
      "status": "no-application-on-file"
    },
    "verification": {
      "kind": "foreign-license",
      "status": "verified",
      "participant": {
        "partyId": "ID-11f17424",
        "type": "person",
        "name": "Ava Good",
        "identifiers": [
          {
            "kind": "cast-key",
            "value": "ava-good"
          }
        ],
        "roles": [
          {
            "role": "customer"
          }
        ],
        "status": "active"
      }
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "credit-jacket-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

Apply & book

itinCreditApply

foreignId.itinCreditApply · POST /foreign-ids/itin-credit-apply · gate key · sandbox · answers ForeignIdItinCreditApply@1

No input — this capability takes no request body.

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

the SDK — foreignId.itinCreditApply
import { foreignId } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await foreignId.itinCreditApply()
POST /foreign-ids/itin-credit-apply
curl -X POST https://apis.vin/foreign-ids/itin-credit-apply \
  -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.837Z · HTTP 200
{
  "type": "OK",
  "answers": "ForeignIdItinCreditApply@1",
  "value": {
    "vin": "1HGCM82633A004352",
    "noun": "foreignId",
    "asOf": "2026-08-10",
    "application": {
      "status": "no-application-on-file"
    },
    "itinApplication": {
      "applicationId": "app_0692329b",
      "lane": "itin",
      "status": "recorded"
    }
  },
  "evidence": {
    "vin": "1HGCM82633A004352",
    "noun": "foreignId",
    "asOf": "2026-08-10",
    "application": {
      "status": "no-application-on-file"
    },
    "itinApplication": {
      "applicationId": "app_0692329b",
      "lane": "itin",
      "status": "recorded"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "credit-jacket-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

Authorize & resolve

matriculaAccept

foreignId.matriculaAccept · GET /foreign-ids/matricula-accept · gate none · sandbox · answers ForeignIdMatriculaAccept@1

No input — this capability takes no request body.

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

the SDK — foreignId.matriculaAccept
import { foreignId } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await foreignId.matriculaAccept()
GET /foreign-ids/matricula-accept
curl 'https://apis.vin/foreign-ids/matricula-accept'

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.837Z · HTTP 200
{
  "type": "OK",
  "answers": "ForeignIdMatriculaAccept@1",
  "value": {
    "vin": "1HGCM82633A004352",
    "noun": "foreignId",
    "asOf": "2026-08-10",
    "application": {
      "status": "no-application-on-file"
    },
    "verification": {
      "kind": "matricula-consular",
      "status": "verified",
      "participant": {
        "partyId": "ID-11f17424",
        "type": "person",
        "name": "Ava Good",
        "identifiers": [
          {
            "kind": "cast-key",
            "value": "ava-good"
          }
        ],
        "roles": [
          {
            "role": "customer"
          }
        ],
        "status": "active"
      }
    }
  },
  "evidence": {
    "vin": "1HGCM82633A004352",
    "noun": "foreignId",
    "asOf": "2026-08-10",
    "application": {
      "status": "no-application-on-file"
    },
    "verification": {
      "kind": "matricula-consular",
      "status": "verified",
      "participant": {
        "partyId": "ID-11f17424",
        "type": "person",
        "name": "Ava Good",
        "identifiers": [
          {
            "kind": "cast-key",
            "value": "ava-good"
          }
        ],
        "roles": [
          {
            "role": "customer"
          }
        ],
        "status": "active"
      }
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "credit-jacket-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

More actions

diplomatExempt

foreignId.diplomatExempt · POST /foreign-ids/diplomat-exempt · gate key · sandbox · answers ForeignIdDiplomatExempt@1

No input — this capability takes no request body.

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

the SDK — foreignId.diplomatExempt
import { foreignId } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await foreignId.diplomatExempt()
POST /foreign-ids/diplomat-exempt
curl -X POST https://apis.vin/foreign-ids/diplomat-exempt \
  -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.837Z · HTTP 200
{
  "type": "OK",
  "answers": "ForeignIdDiplomatExempt@1",
  "value": {
    "vin": "1HGCM82633A004352",
    "noun": "foreignId",
    "asOf": "2026-08-10",
    "application": {
      "status": "no-application-on-file"
    },
    "exemption": {
      "status": "no-diplomat-status-on-file"
    }
  },
  "evidence": {
    "vin": "1HGCM82633A004352",
    "noun": "foreignId",
    "asOf": "2026-08-10",
    "application": {
      "status": "no-application-on-file"
    },
    "exemption": {
      "status": "no-diplomat-status-on-file"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "credit-jacket-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

noSsnUnderwrite

foreignId.noSsnUnderwrite · POST /foreign-ids/no-ssn-underwrite · gate key · sandbox · answers ForeignIdNoSsnUnderwrite@1

No input — this capability takes no request body.

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

the SDK — foreignId.noSsnUnderwrite
import { foreignId } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await foreignId.noSsnUnderwrite()
POST /foreign-ids/no-ssn-underwrite
curl -X POST https://apis.vin/foreign-ids/no-ssn-underwrite \
  -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.837Z · HTTP 200
{
  "type": "OK",
  "answers": "ForeignIdNoSsnUnderwrite@1",
  "value": {
    "vin": "1HGCM82633A004352",
    "noun": "foreignId",
    "asOf": "2026-08-10",
    "application": {
      "status": "no-application-on-file"
    },
    "underwrite": {
      "status": "ssn-ordinary-path"
    }
  },
  "evidence": {
    "vin": "1HGCM82633A004352",
    "noun": "foreignId",
    "asOf": "2026-08-10",
    "application": {
      "status": "no-application-on-file"
    },
    "underwrite": {
      "status": "ssn-ordinary-path"
    }
  },
  "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

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.

ForeignId · Class model

ForeignId · 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.

fleetVehicle

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

fraudCase

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

On this page

Identity
Events
Discover & read
visaStatusCheck
foreignLicenseVerify
Apply & book
itinCreditApply
Authorize & resolve
matriculaAccept
More actions
diplomatExempt
noSsnUnderwrite
Data model
CreditApplication
Modeled