credential

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

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

Identity


Noun	`credential`
Pillar	Data (facets: 6 data · 6 services · 1 commerce)
Capabilities	13 — 0 live · 13 sandbox · 0 declared
Entities	`Credential`
Doors	`aggregator.vin`
SDK	`Vin.credential.*` from `apis.vin`
Address	`/catalog/credential#{action}` — the anchor IS the wire name minus `credential.`

Events

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

Credential.attested@1 — emitted by attest
Credential.failed@1 — emitted by pay
Credential.issued@1 — emitted by issue
Credential.paid@1 — emitted by pay
Credential.provisioned@1 — emitted by provision
Credential.renewed@1 — emitted by renew
Credential.revoked@1 — emitted by revoke
Credential.rotated@1 — emitted by rotate

Discover & read

read

credential.read · GET /credentials/read · gate none · sandbox · answers CredentialRead@1

Field	Type	Required	Notes
`vin`	`string`	no	—

Door — aggregator.vin serves this noun on its two routes: / (the landing) · /5FNRL6H62TB026969 (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 — credential.read

import { credential } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await credential.read({"vin":"5FNRL6H62TB026969"})

GET /credentials/read

curl 'https://apis.vin/credentials/read?vin=5FNRL6H62TB026969'

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.855Z · HTTP 200

{
  "type": "OK",
  "answers": "CredentialRead@1",
  "value": {
    "vin": "5FNRL6H62TB026969",
    "noun": "credential",
    "asOf": "2026-08-10",
    "credential": {
      "id": "crd_a4ed9b79",
      "tokenized": true,
      "rotatedAt": "2026-07-20"
    }
  },
  "evidence": {
    "vin": "5FNRL6H62TB026969",
    "noun": "credential",
    "asOf": "2026-08-10",
    "credential": {
      "id": "crd_a4ed9b79",
      "tokenized": true,
      "rotatedAt": "2026-07-20"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "paperwork-desk-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

history

credential.history · GET /credentials/history · gate none · sandbox · answers CredentialHistory@1

Field	Type	Required	Notes
`vin`	`string`	no	—

Door — aggregator.vin serves this noun on its two routes: / (the landing) · /5FNRL6H62TB026969 (the VIN lens).

the SDK — credential.history

import { credential } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await credential.history({"vin":"5FNRL6H62TB026969"})

GET /credentials/history

curl 'https://apis.vin/credentials/history?vin=5FNRL6H62TB026969'

receipt · executed 2026-08-17T12:42:09.853Z · HTTP 200

{
  "type": "OK",
  "answers": "CredentialHistory@1",
  "value": {
    "vin": "5FNRL6H62TB026969",
    "noun": "credential",
    "asOf": "2026-08-10",
    "history": {
      "standing": "revoked",
      "events": [
        {
          "date": "2026-04-12",
          "event": "issued"
        },
        {
          "date": "2026-06-23",
          "event": "revoked"
        }
      ],
      "count": 2
    }
  },
  "evidence": {
    "vin": "5FNRL6H62TB026969",
    "noun": "credential",
    "asOf": "2026-08-10",
    "history": {
      "standing": "revoked",
      "events": [
        {
          "date": "2026-04-12",
          "event": "issued"
        },
        {
          "date": "2026-06-23",
          "event": "revoked"
        }
      ],
      "count": 2
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "paperwork-desk-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

status

credential.status · GET /credentials/status · gate none · sandbox · answers CredentialStatus@1

Field	Type	Required	Notes
`vin`	`string`	no	—

Door — aggregator.vin serves this noun on its two routes: / (the landing) · /5FNRL6H62TB026969 (the VIN lens).

the SDK — credential.status

import { credential } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await credential.status({"vin":"5FNRL6H62TB026969"})

GET /credentials/status

curl 'https://apis.vin/credentials/status?vin=5FNRL6H62TB026969'

receipt · executed 2026-08-17T12:42:09.878Z · HTTP 200

{
  "type": "OK",
  "answers": "CredentialStatus@1",
  "value": {
    "vin": "5FNRL6H62TB026969",
    "noun": "credential",
    "asOf": "2026-08-10",
    "status": {
      "standing": "revoked",
      "agentKey": "revoked",
      "connection": "degraded"
    }
  },
  "evidence": {
    "vin": "5FNRL6H62TB026969",
    "noun": "credential",
    "asOf": "2026-08-10",
    "status": {
      "standing": "revoked",
      "agentKey": "revoked",
      "connection": "degraded"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "paperwork-desk-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

verify

credential.verify · GET /credentials/verify · gate key · sandbox · answers CredentialVerify@1

Field	Type	Required	Notes
`vin`	`string`	no	—

Door — aggregator.vin serves this noun on its two routes: / (the landing) · /5FNRL6H62TB026969 (the VIN lens).

the SDK — credential.verify

import { credential } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await credential.verify({"vin":"5FNRL6H62TB026969"})

GET /credentials/verify

curl 'https://apis.vin/credentials/verify?vin=5FNRL6H62TB026969'

receipt · executed 2026-08-17T12:42:09.885Z · HTTP 200

{
  "type": "OK",
  "answers": "CredentialVerify@1",
  "value": {
    "vin": "5FNRL6H62TB026969",
    "noun": "credential",
    "asOf": "2026-08-10",
    "verification": {
      "valid": false,
      "standing": "revoked",
      "reason": "credential-revoked"
    }
  },
  "evidence": {
    "vin": "5FNRL6H62TB026969",
    "noun": "credential",
    "asOf": "2026-08-10",
    "verification": {
      "valid": false,
      "standing": "revoked",
      "reason": "credential-revoked"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "paperwork-desk-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

Apply & book

provision

credential.provision · POST /credentials/provision · gate offer · sandbox · answers CredentialProvision@1

Field	Type	Required	Notes
`vin`	`string`	no	—

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) · /5FNRL6H62TB026969 (the VIN lens).

Emits — Credential.provisioned@1.

the SDK — credential.provision

import { credential } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await credential.provision({"vin":"5FNRL6H62TB026969"})

POST /credentials/provision

curl -X POST https://apis.vin/credentials/provision \
  -H 'content-type: application/json' \
  -d '{"vin":"5FNRL6H62TB026969"}'

receipt · executed 2026-08-17T12:42:09.854Z · HTTP 200

{
  "type": "OK",
  "answers": "CredentialProvision@1",
  "value": {
    "vin": "5FNRL6H62TB026969",
    "noun": "credential",
    "asOf": "2026-08-10",
    "provisioning": {
      "id": "crd_a4ed9b79",
      "status": "already-provisioned",
      "connection": "degraded"
    }
  },
  "evidence": {
    "vin": "5FNRL6H62TB026969",
    "noun": "credential",
    "asOf": "2026-08-10",
    "provisioning": {
      "id": "crd_a4ed9b79",
      "status": "already-provisioned",
      "connection": "degraded"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "paperwork-desk-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

Pay & settle

pay

credential.pay · POST /credentials/pay · gate offer · sandbox · answers CredentialPay@1

Field	Type	Required	Notes
`vin`	`string`	no	—

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) · /5FNRL6H62TB026969 (the VIN lens).

Emits — Credential.failed@1 · Credential.paid@1.

the SDK — credential.pay

import { credential } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await credential.pay({"vin":"5FNRL6H62TB026969"})

POST /credentials/pay

curl -X POST https://apis.vin/credentials/pay \
  -H 'content-type: application/json' \
  -d '{"vin":"5FNRL6H62TB026969"}'

receipt · executed 2026-08-17T12:42:09.854Z · HTTP 200

{
  "type": "OK",
  "answers": "CredentialPay@1",
  "value": {
    "vin": "5FNRL6H62TB026969",
    "noun": "credential",
    "asOf": "2026-08-10",
    "payment": {
      "id": "PAY-346465c7",
      "amountCents": 1500,
      "currency": "USD",
      "status": "settled"
    },
    "payer": {
      "name": "Ava Good",
      "castRow": "super-prime",
      "creditTier": "super-prime"
    }
  },
  "evidence": {
    "vin": "5FNRL6H62TB026969",
    "noun": "credential",
    "asOf": "2026-08-10",
    "payment": {
      "id": "PAY-346465c7",
      "amountCents": 1500,
      "currency": "USD",
      "status": "settled"
    },
    "payer": {
      "name": "Ava Good",
      "castRow": "super-prime",
      "creditTier": "super-prime"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "paperwork-desk-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

Fulfill & operate

issue

credential.issue · POST /credentials/issue · gate offer · sandbox · answers CredentialIssue@1

Field	Type	Required	Notes
`vin`	`string`	no	—

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) · /5FNRL6H62TB026969 (the VIN lens).

Emits — Credential.issued@1.

the SDK — credential.issue

import { credential } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await credential.issue({"vin":"5FNRL6H62TB026969"})

POST /credentials/issue

curl -X POST https://apis.vin/credentials/issue \
  -H 'content-type: application/json' \
  -d '{"vin":"5FNRL6H62TB026969"}'

receipt · executed 2026-08-17T12:42:09.853Z · HTTP 200

{
  "type": "OK",
  "answers": "CredentialIssue@1",
  "value": {
    "vin": "5FNRL6H62TB026969",
    "noun": "credential",
    "asOf": "2026-08-10",
    "issue": {
      "id": "crd_a4ed9b79",
      "status": "reissued",
      "priorStanding": "revoked",
      "tokenized": true
    }
  },
  "evidence": {
    "vin": "5FNRL6H62TB026969",
    "noun": "credential",
    "asOf": "2026-08-10",
    "issue": {
      "id": "crd_a4ed9b79",
      "status": "reissued",
      "priorStanding": "revoked",
      "tokenized": true
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "paperwork-desk-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

rotate

credential.rotate · POST /credentials/rotate · gate offer · sandbox · answers CredentialRotate@1

Field	Type	Required	Notes
`vin`	`string`	no	—

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) · /5FNRL6H62TB026969 (the VIN lens).

Emits — Credential.rotated@1.

the SDK — credential.rotate

import { credential } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await credential.rotate({"vin":"5FNRL6H62TB026969"})

POST /credentials/rotate

curl -X POST https://apis.vin/credentials/rotate \
  -H 'content-type: application/json' \
  -d '{"vin":"5FNRL6H62TB026969"}'

receipt · executed 2026-08-17T12:42:09.869Z · HTTP 200

{
  "type": "OK",
  "answers": "CredentialRotate@1",
  "value": {
    "vin": "5FNRL6H62TB026969",
    "noun": "credential",
    "asOf": "2026-08-10",
    "rotation": {
      "status": "revoked-cannot-rotate",
      "id": "crd_a4ed9b79"
    }
  },
  "evidence": {
    "vin": "5FNRL6H62TB026969",
    "noun": "credential",
    "asOf": "2026-08-10",
    "rotation": {
      "status": "revoked-cannot-rotate",
      "id": "crd_a4ed9b79"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "paperwork-desk-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

Authorize & resolve

attest

credential.attest · POST /credentials/attest · gate offer · sandbox · answers CredentialAttest@1

Field	Type	Required	Notes
`vin`	`string`	no	—

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) · /5FNRL6H62TB026969 (the VIN lens).

Emits — Credential.attested@1.

the SDK — credential.attest

import { credential } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await credential.attest({"vin":"5FNRL6H62TB026969"})

POST /credentials/attest

curl -X POST https://apis.vin/credentials/attest \
  -H 'content-type: application/json' \
  -d '{"vin":"5FNRL6H62TB026969"}'

receipt · executed 2026-08-17T12:42:09.853Z · HTTP 200

{
  "type": "OK",
  "answers": "CredentialAttest@1",
  "value": {
    "vin": "5FNRL6H62TB026969",
    "noun": "credential",
    "asOf": "2026-08-10",
    "attestation": {
      "id": "crd_a4ed9b79",
      "custody": "connection",
      "vaulted": true,
      "tokenized": true,
      "secretDisclosed": false,
      "standing": "revoked"
    }
  },
  "evidence": {
    "vin": "5FNRL6H62TB026969",
    "noun": "credential",
    "asOf": "2026-08-10",
    "attestation": {
      "id": "crd_a4ed9b79",
      "custody": "connection",
      "vaulted": true,
      "tokenized": true,
      "secretDisclosed": false,
      "standing": "revoked"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "paperwork-desk-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

revoke

credential.revoke · POST /credentials/revoke · gate offer · sandbox · answers CredentialRevoke@1

Field	Type	Required	Notes
`vin`	`string`	no	—

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) · /5FNRL6H62TB026969 (the VIN lens).

Emits — Credential.revoked@1.

the SDK — credential.revoke

import { credential } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await credential.revoke({"vin":"5FNRL6H62TB026969"})

POST /credentials/revoke

curl -X POST https://apis.vin/credentials/revoke \
  -H 'content-type: application/json' \
  -d '{"vin":"5FNRL6H62TB026969"}'

receipt · executed 2026-08-17T12:42:09.866Z · HTTP 200

{
  "type": "OK",
  "answers": "CredentialRevoke@1",
  "value": {
    "vin": "5FNRL6H62TB026969",
    "noun": "credential",
    "asOf": "2026-08-10",
    "revocation": {
      "status": "already-revoked",
      "id": "crd_a4ed9b79"
    }
  },
  "evidence": {
    "vin": "5FNRL6H62TB026969",
    "noun": "credential",
    "asOf": "2026-08-10",
    "revocation": {
      "status": "already-revoked",
      "id": "crd_a4ed9b79"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "paperwork-desk-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

Lifecycle & state

renew

credential.renew · POST /credentials/renew · gate offer · sandbox · answers CredentialRenew@1

Field	Type	Required	Notes
`vin`	`string`	no	—

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) · /5FNRL6H62TB026969 (the VIN lens).

Emits — Credential.renewed@1.

the SDK — credential.renew

import { credential } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await credential.renew({"vin":"5FNRL6H62TB026969"})

POST /credentials/renew

curl -X POST https://apis.vin/credentials/renew \
  -H 'content-type: application/json' \
  -d '{"vin":"5FNRL6H62TB026969"}'

receipt · executed 2026-08-17T12:42:09.860Z · HTTP 200

{
  "type": "OK",
  "answers": "CredentialRenew@1",
  "value": {
    "vin": "5FNRL6H62TB026969",
    "noun": "credential",
    "asOf": "2026-08-10",
    "renewal": {
      "status": "standing-revoked",
      "id": "crd_a4ed9b79"
    }
  },
  "evidence": {
    "vin": "5FNRL6H62TB026969",
    "noun": "credential",
    "asOf": "2026-08-10",
    "renewal": {
      "status": "standing-revoked",
      "id": "crd_a4ed9b79"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "paperwork-desk-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

More actions

expiry

credential.expiry · GET /credentials/expiry · gate none · sandbox · answers CredentialExpiry@1

Field	Type	Required	Notes
`vin`	`string`	no	—

Door — aggregator.vin serves this noun on its two routes: / (the landing) · /5FNRL6H62TB026969 (the VIN lens).

the SDK — credential.expiry

import { credential } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await credential.expiry({"vin":"5FNRL6H62TB026969"})

GET /credentials/expiry

curl 'https://apis.vin/credentials/expiry?vin=5FNRL6H62TB026969'

receipt · executed 2026-08-17T12:42:09.853Z · HTTP 200

{
  "type": "OK",
  "answers": "CredentialExpiry@1",
  "value": {
    "vin": "5FNRL6H62TB026969",
    "noun": "credential",
    "asOf": "2026-08-10",
    "expiry": {
      "expiresAt": "2027-03-08",
      "expired": false,
      "standing": "revoked"
    }
  },
  "evidence": {
    "vin": "5FNRL6H62TB026969",
    "noun": "credential",
    "asOf": "2026-08-10",
    "expiry": {
      "expiresAt": "2027-03-08",
      "expired": false,
      "standing": "revoked"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "paperwork-desk-sandbox"
  },
  "events": [],
  "meter": {
    "charged": "0.00",
    "posted": false
  }
}

scopes

credential.scopes · GET /credentials/scopes · gate none · sandbox · answers CredentialScopes@1

Field	Type	Required	Notes
`vin`	`string`	no	—

Door — aggregator.vin serves this noun on its two routes: / (the landing) · /5FNRL6H62TB026969 (the VIN lens).

the SDK — credential.scopes

import { credential } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await credential.scopes({"vin":"5FNRL6H62TB026969"})

GET /credentials/scopes

curl 'https://apis.vin/credentials/scopes?vin=5FNRL6H62TB026969'

receipt · executed 2026-08-17T12:42:09.878Z · HTTP 200

{
  "type": "OK",
  "answers": "CredentialScopes@1",
  "value": {
    "vin": "5FNRL6H62TB026969",
    "noun": "credential",
    "asOf": "2026-08-10",
    "scopes": {
      "granted": [],
      "standing": "revoked"
    }
  },
  "evidence": {
    "vin": "5FNRL6H62TB026969",
    "noun": "credential",
    "asOf": "2026-08-10",
    "scopes": {
      "granted": [],
      "standing": "revoked"
    }
  },
  "provenance": {
    "simulated": true,
    "environment": "sandbox",
    "source": "paperwork-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.

Schema

Property	Type	Notes
`id`	`id`	crd_ vault pointer, write-only
`tokenized`	`bool`	—
`rotatedAt`	`datetime`	—

Relationships

From	To	Cardinality	As
`connection`	`credential`	`1:1`	`custody`

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.

Credential · Class model

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

credential

On this page