@openvtc/trust-tasks 0.28.1 → 0.28.3

package/dist/vta/dids/keys/add/1.0/payload.js

@@ -0,0 +1,1469 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vta/dids/keys/add/1.0/payload.schema.json
+ */
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vta/dids/keys/add/1.0";
+/**
+ * The earlier version of this specification that this one declares it
+ * extends (front matter `extends`, SPEC §5.2 "Declared extension"), or
+ * `null`. Only the direct declaration — follow the chain with
+ * `extendsChain` / `readForSpec`.
+ */
+export const EXTENDS = null;
+/**
+ * Why this version is deprecated, or `null` while it is current. A
+ * superseded or retired version is still supported, and is withdrawn from
+ * this package in a later scheduled batch (SPEC "Superseded and Withdrawn
+ * Versions").
+ */
+export const DEPRECATION = null;
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vta/dids/keys/add/1.0#response";
+/**
+ * This specification's payload schema, as a value.
+ *
+ * SPEC.md §7.2 item 2 is performed against this. It is shipped as data
+ * rather than only as a `.json` file because TypeScript types are erased
+ * at runtime: without a schema a consumer has nothing to validate, and
+ * every REQUIRED payload member is optional in practice. Cross-file
+ * `$ref`s are already inlined, so it needs no resolver.
+ */
+export const PAYLOAD_SCHEMA = {
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://trusttasks.org/spec/vta/dids/keys/add/1.0",
+    "title": "VTA DIDs — Keys Add — payload",
+    "description": "Add a newly minted key to a role of a key-role identity — a post-quantum attestation key beside a classical one, a second operational key. `update` and `authenticator` keys are not added.",
+    "type": "object",
+    "additionalProperties": false,
+    "required": [
+        "did",
+        "role",
+        "keyType"
+    ],
+    "properties": {
+        "did": {
+            "type": "string",
+            "minLength": 1,
+            "description": "The key-role identity, by DID (for a `did:scid` identity, the DID without `src`)."
+        },
+        "role": {
+            "$ref": "#/$defs/IdentityKeyRole",
+            "description": "The role the key joins: `attestation`, `operational` or `messaging`. Any other is refused with `vta/dids:notApplicableToRole`."
+        },
+        "keyType": {
+            "$ref": "#/$defs/KeyType",
+            "description": "Algorithm of the key to mint; must suit the role (CONVENTIONS.md §2.2)."
+        },
+        "label": {
+            "type": "string",
+            "maxLength": 256,
+            "description": "Operator-facing label. Never published."
+        },
+        "expectedVersionId": {
+            "type": "string",
+            "minLength": 1,
+            "description": "Optimistic-concurrency precondition: the version identifier (method profile §3) the caller based this change on, for example `keys/list`'s `versionId`. The VTA MUST refuse with `vta/dids:versionConflict` if the identity has moved past it. Not optional for anything a person looked at."
+        },
+        "dryRun": {
+            "type": "boolean",
+            "description": "Compute and return the preview without writing anything but the plan (CONVENTIONS.md §6.1). Absent reads as false."
+        },
+        "previewId": {
+            "type": "string",
+            "minLength": 16,
+            "description": "Apply exactly the plan a previous dry run of this same request returned, or nothing (CONVENTIONS.md §6.1); what every approval is bound to."
+        },
+        "reason": {
+            "type": "string",
+            "maxLength": 1024,
+            "description": "Why the change is being made, for the audit trail and for the other approvers. Never published."
+        },
+        "ext": {
+            "$ref": "#/$defs/Ext"
+        }
+    },
+    "$defs": {
+        "Response": {
+            "$anchor": "response",
+            "title": "VTA DIDs — Keys Add — response payload",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "did",
+                "outcome"
+            ],
+            "properties": {
+                "did": {
+                    "type": "string",
+                    "minLength": 1
+                },
+                "outcome": {
+                    "$ref": "#/$defs/KeyChangeOutcome"
+                },
+                "preview": {
+                    "$ref": "#/$defs/IdentityChangePreview",
+                    "description": "Present when `outcome` is `preview`, `pendingApproval` or `awaitingRecoveryProof`: the plan, and what an approval is bound to."
+                },
+                "approvals": {
+                    "$ref": "#/$defs/KeyChangeApprovalState",
+                    "description": "Present when `outcome` is `pendingApproval`."
+                },
+                "newVersionId": {
+                    "type": "string",
+                    "description": "Present when `outcome` is `applied`: the version identifier of the change. Pass it as the next change's `expectedVersionId`."
+                },
+                "keys": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/$defs/IdentityRoleKey"
+                    },
+                    "description": "Every key whose state this change sets or would set, after the change."
+                },
+                "rotation": {
+                    "$ref": "#/$defs/KeyChangeRecord"
+                },
+                "publication": {
+                    "$ref": "#/$defs/Publication",
+                    "description": "Present when `outcome` is `applied`."
+                },
+                "ext": {
+                    "$ref": "#/$defs/Ext"
+                }
+            }
+        },
+        "Ext": {
+            "title": "Ext",
+            "description": "Vendor-namespaced extension object per SPEC.md §4.5.1. Each immediate key MUST be a reverse-DNS namespace; structure under each namespace is opaque to the framework.",
+            "type": "object",
+            "minProperties": 1,
+            "additionalProperties": true,
+            "propertyNames": {
+                "pattern": "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$"
+            }
+        },
+        "Publication": {
+            "title": "Publication",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "selfPublish"
+            ],
+            "description": "How the change reaches resolvers.",
+            "properties": {
+                "selfPublish": {
+                    "type": "boolean",
+                    "description": "True when no hosting service holds the identifier for the VTA: the caller must publish `artifacts`, and until it does resolvers see the previous version."
+                },
+                "artifacts": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/$defs/PublishedArtifact"
+                    },
+                    "description": "Present when `selfPublish` is true."
+                }
+            }
+        },
+        "PublishedArtifact": {
+            "title": "PublishedArtifact",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "name",
+                "mediaType",
+                "content"
+            ],
+            "description": "A file the identifier's method publishes, as the method profile names it (`did.jsonl` for did:webvh, `did.json` and `keri.cesr` for did:webs).",
+            "properties": {
+                "name": {
+                    "type": "string",
+                    "minLength": 1,
+                    "maxLength": 128
+                },
+                "mediaType": {
+                    "type": "string",
+                    "minLength": 1
+                },
+                "content": {
+                    "type": "string",
+                    "description": "The artefact's content, or for an append-only artefact the appended part, as text."
+                }
+            }
+        },
+        "KeyChangeRecord": {
+            "title": "KeyChangeRecord",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "rotationId",
+                "role",
+                "kind",
+                "state"
+            ],
+            "description": "One change to a role's key set, from preview to completion. The identifier's history is the authority for what was published; this record adds which change was which and, in the custody projection, who asked, who approved, and why.",
+            "properties": {
+                "rotationId": {
+                    "type": "string",
+                    "minLength": 1
+                },
+                "role": {
+                    "$ref": "#/$defs/IdentityKeyRole"
+                },
+                "kind": {
+                    "$ref": "#/$defs/KeyChangeKind"
+                },
+                "state": {
+                    "$ref": "#/$defs/KeyChangeState"
+                },
+                "predecessors": {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    },
+                    "description": "Verification-method identifiers (for `update`, public keys or commitments) leaving the role."
+                },
+                "successors": {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    },
+                    "description": "Verification-method identifiers (for `update`, public keys or commitments) entering the role."
+                },
+                "startedInVersionId": {
+                    "type": "string"
+                },
+                "endedInVersionId": {
+                    "type": "string"
+                },
+                "startedAt": {
+                    "type": "string",
+                    "format": "date-time"
+                },
+                "cacheHorizonAt": {
+                    "type": "string",
+                    "format": "date-time",
+                    "description": "Planned rotations: the publishing change's cache horizon (CONVENTIONS.md §10.1). The switch and any retirement happen no earlier."
+                },
+                "activatesAt": {
+                    "type": "string",
+                    "format": "date-time",
+                    "description": "When the successor becomes `active` and the predecessor `retiring`; never before `cacheHorizonAt`."
+                },
+                "overlapUntil": {
+                    "type": "string",
+                    "format": "date-time",
+                    "description": "Custody projection only. End of the overlap."
+                },
+                "autoRetire": {
+                    "type": "boolean",
+                    "description": "Custody projection only. Whether the VTA retires the predecessor itself at `overlapUntil`."
+                },
+                "endedAt": {
+                    "type": "string",
+                    "format": "date-time"
+                },
+                "initiatedBy": {
+                    "type": "string",
+                    "description": "Custody projection only. VID of the administrator whose signed request started the change."
+                },
+                "approvals": {
+                    "$ref": "#/$defs/KeyChangeApprovalState"
+                },
+                "reason": {
+                    "type": "string",
+                    "maxLength": 1024,
+                    "description": "Custody projection only. The operator's stated reason. Never published."
+                },
+                "ext": {
+                    "$ref": "#/$defs/Ext"
+                }
+            }
+        },
+        "KeyChangeApprovalState": {
+            "title": "KeyChangeApprovalState",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "required",
+                "received",
+                "expiresAt"
+            ],
+            "description": "Approval progress of a change the VTA's policy gates on approvals (CONVENTIONS.md §6).",
+            "properties": {
+                "required": {
+                    "type": "integer",
+                    "minimum": 1,
+                    "description": "Distinct approvals the VTA's policy requires."
+                },
+                "received": {
+                    "type": "integer",
+                    "minimum": 0,
+                    "description": "Distinct approvals recorded so far, the initiator's own included."
+                },
+                "approvals": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/$defs/RecordedApproval"
+                    },
+                    "description": "The approvals recorded. Custody projection only; omitted from a response to anyone who is not themselves an eligible approver of this change."
+                },
+                "expiresAt": {
+                    "type": "string",
+                    "format": "date-time",
+                    "description": "When the preview, and every approval bound to it, stops being usable."
+                }
+            }
+        },
+        "RecordedApproval": {
+            "title": "RecordedApproval",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "approver",
+                "evidence"
+            ],
+            "properties": {
+                "approver": {
+                    "type": "string",
+                    "minLength": 1,
+                    "description": "VID of the approver."
+                },
+                "evidence": {
+                    "$ref": "#/$defs/ApprovalEvidenceKind"
+                },
+                "recordedAt": {
+                    "type": "string",
+                    "format": "date-time"
+                }
+            }
+        },
+        "ApprovalEvidenceKind": {
+            "title": "ApprovalEvidenceKind",
+            "type": "string",
+            "enum": [
+                "didSigned",
+                "webauthn",
+                "approverSigned"
+            ],
+            "description": "The evidence an approval was recorded on, as `auth/step-up/approve-response` names it. Only the approver's own evidence is ever recorded: a proof by a key the VTA records as acting for an approver — a console signing key or any other delegation — is never an approval (CONVENTIONS.md §6.3)."
+        },
+        "KeyChangeState": {
+            "title": "KeyChangeState",
+            "type": "string",
+            "enum": [
+                "pendingApproval",
+                "awaitingRecoveryProof",
+                "staged",
+                "overlapping",
+                "completed",
+                "aborted",
+                "expired"
+            ],
+            "description": "`pendingApproval` — awaiting the approvals the VTA's policy requires; nothing is published. `awaitingRecoveryProof` — approved, and waiting for the recovery custodian's proof over the change; nothing is published. `staged` — successor published, not yet used. `overlapping` — successor active, predecessor `retiring`. `completed` — every predecessor retired, or the change is published and any overlap it began has ended. `aborted` — the successor was retired instead of the predecessor, or a revocation superseded the change. `expired` — the approvals or the recovery proof did not arrive before the preview expired; nothing was published."
+        },
+        "KeyChangeKind": {
+            "title": "KeyChangeKind",
+            "type": "string",
+            "enum": [
+                "planned",
+                "compromise",
+                "addition",
+                "recovery"
+            ],
+            "description": "`planned` — a successor was staged, activated, and the predecessor retired on the operator's schedule. `compromise` — a key was revoked and, where the role would otherwise be empty, replaced in the same change. `addition` — a key joined a role without anything leaving it. `recovery` — the identifier's update authority moved to the committed recovery key, because the VTA's own update keys were lost or may be in someone else's hands."
+        },
+        "IdentityKeyRole": {
+            "title": "IdentityKeyRole",
+            "type": "string",
+            "enum": [
+                "attestation",
+                "operational",
+                "messaging",
+                "update",
+                "authenticator"
+            ],
+            "description": "The named key role a key occupies in an identity (CONVENTIONS.md §2; VTI-KEY-070 onward). `attestation` — the only keys in `assertionMethod`; sign the identity's attestation artefacts (credentials, endorsements, status lists) through the VTA's signing service and nowhere else. Generated inside the VTA, never derived, never exportable, never in a backup. `operational` — the only keys the identity's own process uses in `authentication`; sign the node's own traffic (Trust Task requests and responses, DIDComm and TSP signatures, invitations, notices, audit checkpoints). Derived. `messaging` — the only keys in `keyAgreement`; sign nothing. X25519, derived or generated in its own right and never converted from a signing key. `update` — the identifier's change authority as its DID method states it (a did:webvh log's `updateKeys` and `nextKeyHashes`, a KERI key event log's current and next keys); never a role-bound verification method, never in `keyRoles`. Generated inside the VTA, never derived, never exportable, never in a backup, and always accompanied by a committed recovery key held outside the VTA's protection boundary. `authenticator` — a key held on a person's own authenticator (a WebAuthn passkey), listed in `authentication` of that person's identity only; used only to verify the person's WebAuthn assertions (sign-in and step-up evidence) and never to accept a Data Integrity proof. The VTA never holds its private half, so it is enrolled by the passkey ceremony and never generated, added or rotated by these tasks. Never permitted on the durable identity of a VTA, a VTC or a VTN. No role permits `capabilityInvocation` or `capabilityDelegation` (VTI-KEY-075). The set is an extensible registry: a consumer that meets a role it does not implement MUST rely on the key for nothing, and MUST NOT map it onto a role it does know (VTI-KEY-074)."
+        },
+        "IdentityRoleKey": {
+            "title": "IdentityRoleKey",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "role",
+                "keyType",
+                "state"
+            ],
+            "description": "One key in one role. A key is in exactly one role for its whole life; a change of role is a retirement from one and an addition to another, with fresh material under a fresh identifier.",
+            "properties": {
+                "verificationMethod": {
+                    "type": "string",
+                    "minLength": 1,
+                    "description": "The full verification-method identifier (`did#fragment`) the document publishes the key under and lists in `keyRoles`. Absent for `update` keys, which are never role-bound verification methods (VTI-KEY-093). A VTA minting a method SHOULD derive its fragment from the key (VTI-KEY-150)."
+                },
+                "role": {
+                    "$ref": "#/$defs/IdentityKeyRole"
+                },
+                "updateKeyClass": {
+                    "$ref": "#/$defs/UpdateKeyClass"
+                },
+                "relationships": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/$defs/DidVerificationRelationship"
+                    },
+                    "uniqueItems": true,
+                    "description": "The relationships the key is (or, while `pending`, will be) listed in: always exactly its role's one relationship. Empty for `update`, `retired` and `revoked` keys."
+                },
+                "keyType": {
+                    "$ref": "#/$defs/KeyType"
+                },
+                "publicKeyMultibase": {
+                    "type": "string",
+                    "minLength": 1,
+                    "description": "The public half, multibase-encoded, exactly as published. Absent for a `committed` update key, whose public half the identifier has not yet revealed."
+                },
+                "commitment": {
+                    "type": "string",
+                    "minLength": 1,
+                    "description": "For a `committed` update key: the commitment the identifier publishes (a did:webvh `nextKeyHashes` entry, a KERI next-key digest), in the method's own encoding."
+                },
+                "state": {
+                    "$ref": "#/$defs/KeyLifecycleState"
+                },
+                "publishedInVersionId": {
+                    "type": "string",
+                    "description": "The method's version identifier of the change that first published the key or its commitment (method-profiles/: a did:webvh `versionId`, a KERI event's sequence number and digest). Absent while `pending`."
+                },
+                "removedInVersionId": {
+                    "type": "string",
+                    "description": "Version identifier of the change that retired or revoked the key."
+                },
+                "activatesAt": {
+                    "type": "string",
+                    "format": "date-time",
+                    "description": "For a `staged` key: when the VTA will begin using it — no earlier than the publishing change's cache horizon."
+                },
+                "retireAfter": {
+                    "type": "string",
+                    "format": "date-time",
+                    "description": "For a `retiring` key: the end of its overlap. Custody projection only."
+                },
+                "compromisedSince": {
+                    "type": "string",
+                    "format": "date-time",
+                    "description": "For a `revoked` key: the compromise time (VTI-KEY-121), published as the verification method's `revoked` value. Where it cannot be established, the time the key was first published."
+                },
+                "rotationId": {
+                    "type": "string",
+                    "description": "The rotation this key was introduced or retired by."
+                },
+                "label": {
+                    "type": "string",
+                    "maxLength": 256,
+                    "description": "Operator-facing label. Custody projection only."
+                },
+                "custody": {
+                    "$ref": "#/$defs/IdentityKeyCustody"
+                },
+                "ext": {
+                    "$ref": "#/$defs/Ext"
+                }
+            }
+        },
+        "IdentityKeyCustody": {
+            "title": "IdentityKeyCustody",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "exportable",
+                "neverExportable",
+                "inBackups",
+                "protection"
+            ],
+            "description": "How a key is held. Present only in the custody projection. Carries no key material, and a conforming VTA MUST NOT place any in `ext`.",
+            "properties": {
+                "keyId": {
+                    "type": "string",
+                    "minLength": 1,
+                    "description": "The custodian record identifier (`keys/*`'s `keyId`) behind this key. Absent for a key this VTA does not hold (`protection: externalCustodian`)."
+                },
+                "origin": {
+                    "$ref": "#/$defs/KeyOrigin"
+                },
+                "exportable": {
+                    "type": "boolean",
+                    "description": "Whether the custodian would release the private half. Always `false` for `attestation` and `update` keys. Stated explicitly, never absent."
+                },
+                "neverExportable": {
+                    "type": "boolean",
+                    "description": "True when no authority can make the key exportable. `true` implies `exportable: false`."
+                },
+                "inBackups": {
+                    "type": "boolean",
+                    "description": "Whether the key, or material it can be re-derived or decrypted from, is in the VTA's backups or any state transfer. Always `false` for `attestation` and `update` keys (VTI-KEY-112)."
+                },
+                "protection": {
+                    "$ref": "#/$defs/ProtectionClass"
+                },
+                "boundary": {
+                    "type": "string",
+                    "minLength": 1,
+                    "maxLength": 128,
+                    "description": "Opaque, VTA-assigned label of the protection boundary holding the key (CONVENTIONS.md §5.2). Two keys with the same label are lost or compromised together. A recovery update key MUST carry a label different from every routine update key's. Custody projection only; never published."
+                },
+                "destroyed": {
+                    "type": "boolean",
+                    "description": "True once the private half has been destroyed — a retired `attestation` or `messaging` key. The record survives so the key's past signatures stay attributable."
+                }
+            }
+        },
+        "ProtectionClass": {
+            "title": "ProtectionClass",
+            "type": "string",
+            "enum": [
+                "software",
+                "encryptedAtRest",
+                "enclave",
+                "hardwareModule",
+                "externalCustodian"
+            ],
+            "description": "How a private half is protected (CONVENTIONS.md §5.2). `software` — stored by the VTA without encryption independent of the host (a plain VTA). `encryptedAtRest` — wrapped under a key the VTA holds outside its store (a hardened VTA). `enclave` — held only inside an attested trusted execution environment, wrapped under a key released only to its measurement (a TEE VTA). `hardwareModule` — held by a hardware security module or cloud key service that performs the operation without releasing the key. `externalCustodian` — not held by this VTA at all: a recovery update key, or an `authenticator` key on a person's device."
+        },
+        "KeyOrigin": {
+            "title": "KeyOrigin",
+            "type": "string",
+            "enum": [
+                "derived",
+                "imported",
+                "internal"
+            ],
+            "description": "Where the private key came from. `derived` means the maintainer generated it from a seed it holds and can reproduce it from `derivationPath`; `imported` means it arrived from outside and exists only as stored material; `internal` means the maintainer generated it from a CSPRNG and it is reproducible from nothing at all. The distinction is operationally load-bearing: a `derived` key survives a seed restore, an `imported` one is lost unless it was backed up separately, and an `internal` one cannot be recovered by any means once the maintainer's storage is gone. This member is also the only way a consumer can confirm that a `keys/create` request for an `internal` key was honoured rather than silently downgraded to a derived one — see that specification's `internal` member.",
+            "default": "derived"
+        },
+        "KeyLifecycleState": {
+            "title": "KeyLifecycleState",
+            "type": "string",
+            "enum": [
+                "pending",
+                "staged",
+                "active",
+                "retiring",
+                "retired",
+                "revoked",
+                "committed"
+            ],
+            "description": "Where a key is in its role's lifecycle (CONVENTIONS.md §8, §10). `pending` — planned by a preview or a change awaiting approval; not published; custody projection only. `staged` — published and bound to its role but not yet used, until the publishing change's cache horizon. `active` — the key the VTA uses for new signatures (for `messaging`, advertises for new sessions; for `update`, the current authority). `retiring` — still published but never used to sign again; a retiring `messaging` key still decrypts until retirement. `retired` — removed by planned rotation; what it signed while published stays valid, judged against the identifier version current at issuance. `revoked` — withdrawn for compromise, recorded with `compromisedSince`; what it signed from then on establishes nothing. `committed` — an `update` key the identifier commits to as a successor but has not revealed (a did:webvh `nextKeyHashes` entry, a KERI next-key digest). `retired` and `revoked` are terminal."
+        },
+        "DidVerificationRelationship": {
+            "title": "DidVerificationRelationship",
+            "type": "string",
+            "enum": [
+                "authentication",
+                "assertionMethod",
+                "keyAgreement",
+                "capabilityInvocation",
+                "capabilityDelegation"
+            ],
+            "description": "A DID Core verification relationship."
+        },
+        "UpdateKeyClass": {
+            "title": "UpdateKeyClass",
+            "type": "string",
+            "enum": [
+                "routine",
+                "recovery"
+            ],
+            "description": "For an `update` key only (CONVENTIONS.md §5.3). `routine` — generated and held by the VTA, which authorizes the identity's ordinary changes with it. `recovery` — held by a recovery custodian in a protection boundary other than the VTA's; the VTA holds only its commitment, carries that commitment forward in every change it makes, and can use the key only by asking the custodian for a proof (`RecoverySigningRequest`)."
+        },
+        "KeyType": {
+            "title": "KeyType",
+            "type": "string",
+            "enum": [
+                "ed25519",
+                "x25519",
+                "p256",
+                "mldsa44",
+                "mldsa65"
+            ],
+            "description": "Cryptographic algorithm the key material belongs to. `ed25519` signs (EdDSA), `x25519` performs key agreement and never signs, `p256` signs (ES256), and `mldsa44` and `mldsa65` sign with the post-quantum ML-DSA scheme of US NIST FIPS 204. The set is expected to grow as algorithms are standardised, and growing it is a MINOR change under SPEC.md §5.2: `keyType` selects no schema branch, so adding a value relaxes a constraint rather than narrowing one, and the generated libraries mark this enumeration non-exhaustive so that a consumer absorbs a new value rather than failing to compile. Two ML-DSA parameter sets are carried because two specifications require different ones — W3C Quantum-Resistant Cryptosuites defines Data Integrity suites only for ML-DSA-44, while Trust Spanning Protocol Rev 3 §8.1 mandates ML-DSA-65 — so the parameter set is chosen by whatever consumes the key and the two are not redundant. A consumer that does not implement a value it receives MUST refuse the document rather than substitute one it does support."
+        },
+        "IdentityChangePreview": {
+            "title": "IdentityChangePreview",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "previewId",
+                "method",
+                "expiresAt",
+                "changes",
+                "document",
+                "updateKeyRotates"
+            ],
+            "description": "What a change would publish, computed by the VTA by running the handler it would run to apply it (CONVENTIONS.md §6.1). This is what a consent surface renders and what an approval is bound to.",
+            "properties": {
+                "previewId": {
+                    "type": "string",
+                    "minLength": 16,
+                    "description": "Opaque, unguessable identifier of this exact plan. Carried back by the apply request; every approval and any recovery proof is bound to it."
+                },
+                "method": {
+                    "$ref": "#/$defs/DidMethodName"
+                },
+                "baseVersionId": {
+                    "type": "string",
+                    "description": "The version identifier the plan was computed against. Absent only for a creation. The plan is void once the identifier moves past it."
+                },
+                "expiresAt": {
+                    "type": "string",
+                    "format": "date-time"
+                },
+                "changes": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/$defs/IdentityChange"
+                    },
+                    "description": "Every change the plan would make, including the ones the caller did not ask for — in particular any movement of the update authority the method requires."
+                },
+                "document": {
+                    "type": "object",
+                    "description": "The complete identifier document the change would publish, `keyRoles` included. Public data by construction."
+                },
+                "warnings": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/$defs/PreviewWarning"
+                    },
+                    "uniqueItems": true
+                },
+                "updateKeyRotates": {
+                    "type": "boolean",
+                    "description": "True when applying the plan also moves the identifier's update authority to a committed successor — every change under did:webvh pre-rotation, never a KERI interaction event. Stated as its own member because it is the consequence a reviewer most often misses."
+                },
+                "recoverySigning": {
+                    "$ref": "#/$defs/RecoverySigningRequest"
+                }
+            }
+        },
+        "RecoverySigningRequest": {
+            "title": "RecoverySigningRequest",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "commitment",
+                "keyType",
+                "unsignedChange",
+                "proofOptions"
+            ],
+            "description": "What a recovery custodian must sign for a change that only the recovery key may authorize (CONVENTIONS.md §5.4, §9.4). The custodian MUST check `unsignedChange` itself — render it to its human, confirm that it reveals the recovery key it holds and commits to a fresh recovery key it also holds — and MUST NOT sign on the strength of this request's description alone.",
+            "properties": {
+                "commitment": {
+                    "type": "string",
+                    "minLength": 1,
+                    "description": "The recovery commitment the identifier publishes; the custodian's key MUST be the one it commits to."
+                },
+                "keyType": {
+                    "$ref": "#/$defs/KeyType"
+                },
+                "unsignedChange": {
+                    "type": "string",
+                    "minLength": 1,
+                    "description": "The change exactly as it will be published, without the recovery proof, as JSON text in the method's own form (a did:webvh log entry, a KERI rotation event)."
+                },
+                "proofOptions": {
+                    "type": "object",
+                    "description": "The proof the method requires over `unsignedChange`, without its signature value, as the method profile defines it (for did:webvh, a Data Integrity proof configuration with `proofPurpose: assertionMethod` and the recovery key's `did:key` as `verificationMethod`)."
+                },
+                "expiresAt": {
+                    "type": "string",
+                    "format": "date-time"
+                }
+            }
+        },
+        "PreviewWarning": {
+            "title": "PreviewWarning",
+            "type": "string",
+            "enum": [
+                "singleKeyRole",
+                "algorithmNotInAcceptedSet",
+                "roleWillHaveNoClassicalKey",
+                "attestationReissuanceRequired",
+                "selfPublish",
+                "noWitnesses",
+                "protectionBelowPolicy",
+                "recoveryKeyRevealed"
+            ],
+            "description": "Conditions a human should be shown before approving. `singleKeyRole` — the role will hold one active key. `algorithmNotInAcceptedSet` — a verifier population the VTA knows of does not accept the new key's algorithm. `roleWillHaveNoClassicalKey` — every remaining key is post-quantum. `attestationReissuanceRequired` — revoking this attestation key obliges re-issuance and re-signed status lists (VTI-KEY-133). `selfPublish` — the VTA will not publish the change; the operator must. `noWitnesses` — the identifier has no witnesses, so a party holding the VTA's routine update key can drop the recovery commitment unobserved (CONVENTIONS.md §5.3). `protectionBelowPolicy` — a key will be held at a `ProtectionClass` below what the VTA's policy recommends for its role (a plain VTA holding an attestation key). `recoveryKeyRevealed` — this change uses the recovery key, which must be replaced by a fresh recovery commitment in the same change."
+        },
+        "IdentityChange": {
+            "title": "IdentityChange",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "op",
+                "role"
+            ],
+            "properties": {
+                "op": {
+                    "type": "string",
+                    "enum": [
+                        "addKey",
+                        "retireKey",
+                        "revokeKey",
+                        "rotateUpdateKey",
+                        "commitUpdateKey",
+                        "replaceRecoveryCommitment",
+                        "useRecoveryKey"
+                    ],
+                    "description": "`addKey` — a verification method joins its role's relationship and `keyRoles`. `retireKey` — a verification method leaves its relationship, `keyRoles` and the document. `revokeKey` — a verification method leaves its relationship and `keyRoles`, and stays in `verificationMethod` with `revoked` set to the compromise time (CONVENTIONS.md §9.1). `rotateUpdateKey` — the identifier's update authority moves to a committed routine successor. `commitUpdateKey` — a new routine successor is committed. `replaceRecoveryCommitment` — the recovery commitment changes. `useRecoveryKey` — the change is authorized by the recovery key, which the identifier then reveals."
+                },
+                "role": {
+                    "$ref": "#/$defs/IdentityKeyRole"
+                },
+                "verificationMethod": {
+                    "type": "string"
+                },
+                "keyType": {
+                    "$ref": "#/$defs/KeyType"
+                },
+                "publicKeyMultibase": {
+                    "type": "string"
+                },
+                "commitment": {
+                    "type": "string"
+                },
+                "relationships": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/$defs/DidVerificationRelationship"
+                    },
+                    "uniqueItems": true
+                }
+            }
+        },
+        "DidMethodName": {
+            "title": "DidMethodName",
+            "type": "string",
+            "pattern": "^[a-z0-9]+(:[a-z0-9]+)*$",
+            "description": "The DID method an identity uses, as the method profile that governs it is named: `webvh` for a did:webvh identity, `scid:vh` for the did:scid:vh:1 form of one, `webs` for did:webs. Deliberately a pattern and not an enumeration: a method is added by publishing its profile under method-profiles/, never by changing this schema. A VTA MUST refuse a method it holds no profile for, or whose profile declares it ineligible, with `vta/dids:methodNotEligible`."
+        },
+        "KeyChangeOutcome": {
+            "title": "KeyChangeOutcome",
+            "type": "string",
+            "enum": [
+                "preview",
+                "applied",
+                "pendingApproval",
+                "awaitingRecoveryProof"
+            ],
+            "description": "`preview` — nothing was written; the response carries the plan. `applied` — the change was made (and published, unless `publication.selfPublish`). `pendingApproval` — the plan is recorded and awaits further approvals. `awaitingRecoveryProof` — the plan is approved and waits for the recovery custodian's proof (`preview.recoverySigning`); nothing is published until it arrives."
+        }
+    }
+};
+/** As {@link PAYLOAD_SCHEMA}, for the success-response variant. */
+export const RESPONSE_PAYLOAD_SCHEMA = {
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$ref": "#/$defs/Response",
+    "$defs": {
+        "Response": {
+            "$anchor": "response",
+            "title": "VTA DIDs — Keys Add — response payload",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "did",
+                "outcome"
+            ],
+            "properties": {
+                "did": {
+                    "type": "string",
+                    "minLength": 1
+                },
+                "outcome": {
+                    "$ref": "#/$defs/KeyChangeOutcome"
+                },
+                "preview": {
+                    "$ref": "#/$defs/IdentityChangePreview",
+                    "description": "Present when `outcome` is `preview`, `pendingApproval` or `awaitingRecoveryProof`: the plan, and what an approval is bound to."
+                },
+                "approvals": {
+                    "$ref": "#/$defs/KeyChangeApprovalState",
+                    "description": "Present when `outcome` is `pendingApproval`."
+                },
+                "newVersionId": {
+                    "type": "string",
+                    "description": "Present when `outcome` is `applied`: the version identifier of the change. Pass it as the next change's `expectedVersionId`."
+                },
+                "keys": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/$defs/IdentityRoleKey"
+                    },
+                    "description": "Every key whose state this change sets or would set, after the change."
+                },
+                "rotation": {
+                    "$ref": "#/$defs/KeyChangeRecord"
+                },
+                "publication": {
+                    "$ref": "#/$defs/Publication",
+                    "description": "Present when `outcome` is `applied`."
+                },
+                "ext": {
+                    "$ref": "#/$defs/Ext"
+                }
+            }
+        },
+        "Ext": {
+            "title": "Ext",
+            "description": "Vendor-namespaced extension object per SPEC.md §4.5.1. Each immediate key MUST be a reverse-DNS namespace; structure under each namespace is opaque to the framework.",
+            "type": "object",
+            "minProperties": 1,
+            "additionalProperties": true,
+            "propertyNames": {
+                "pattern": "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$"
+            }
+        },
+        "Publication": {
+            "title": "Publication",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "selfPublish"
+            ],
+            "description": "How the change reaches resolvers.",
+            "properties": {
+                "selfPublish": {
+                    "type": "boolean",
+                    "description": "True when no hosting service holds the identifier for the VTA: the caller must publish `artifacts`, and until it does resolvers see the previous version."
+                },
+                "artifacts": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/$defs/PublishedArtifact"
+                    },
+                    "description": "Present when `selfPublish` is true."
+                }
+            }
+        },
+        "PublishedArtifact": {
+            "title": "PublishedArtifact",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "name",
+                "mediaType",
+                "content"
+            ],
+            "description": "A file the identifier's method publishes, as the method profile names it (`did.jsonl` for did:webvh, `did.json` and `keri.cesr` for did:webs).",
+            "properties": {
+                "name": {
+                    "type": "string",
+                    "minLength": 1,
+                    "maxLength": 128
+                },
+                "mediaType": {
+                    "type": "string",
+                    "minLength": 1
+                },
+                "content": {
+                    "type": "string",
+                    "description": "The artefact's content, or for an append-only artefact the appended part, as text."
+                }
+            }
+        },
+        "KeyChangeRecord": {
+            "title": "KeyChangeRecord",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "rotationId",
+                "role",
+                "kind",
+                "state"
+            ],
+            "description": "One change to a role's key set, from preview to completion. The identifier's history is the authority for what was published; this record adds which change was which and, in the custody projection, who asked, who approved, and why.",
+            "properties": {
+                "rotationId": {
+                    "type": "string",
+                    "minLength": 1
+                },
+                "role": {
+                    "$ref": "#/$defs/IdentityKeyRole"
+                },
+                "kind": {
+                    "$ref": "#/$defs/KeyChangeKind"
+                },
+                "state": {
+                    "$ref": "#/$defs/KeyChangeState"
+                },
+                "predecessors": {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    },
+                    "description": "Verification-method identifiers (for `update`, public keys or commitments) leaving the role."
+                },
+                "successors": {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    },
+                    "description": "Verification-method identifiers (for `update`, public keys or commitments) entering the role."
+                },
+                "startedInVersionId": {
+                    "type": "string"
+                },
+                "endedInVersionId": {
+                    "type": "string"
+                },
+                "startedAt": {
+                    "type": "string",
+                    "format": "date-time"
+                },
+                "cacheHorizonAt": {
+                    "type": "string",
+                    "format": "date-time",
+                    "description": "Planned rotations: the publishing change's cache horizon (CONVENTIONS.md §10.1). The switch and any retirement happen no earlier."
+                },
+                "activatesAt": {
+                    "type": "string",
+                    "format": "date-time",
+                    "description": "When the successor becomes `active` and the predecessor `retiring`; never before `cacheHorizonAt`."
+                },
+                "overlapUntil": {
+                    "type": "string",
+                    "format": "date-time",
+                    "description": "Custody projection only. End of the overlap."
+                },
+                "autoRetire": {
+                    "type": "boolean",
+                    "description": "Custody projection only. Whether the VTA retires the predecessor itself at `overlapUntil`."
+                },
+                "endedAt": {
+                    "type": "string",
+                    "format": "date-time"
+                },
+                "initiatedBy": {
+                    "type": "string",
+                    "description": "Custody projection only. VID of the administrator whose signed request started the change."
+                },
+                "approvals": {
+                    "$ref": "#/$defs/KeyChangeApprovalState"
+                },
+                "reason": {
+                    "type": "string",
+                    "maxLength": 1024,
+                    "description": "Custody projection only. The operator's stated reason. Never published."
+                },
+                "ext": {
+                    "$ref": "#/$defs/Ext"
+                }
+            }
+        },
+        "KeyChangeApprovalState": {
+            "title": "KeyChangeApprovalState",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "required",
+                "received",
+                "expiresAt"
+            ],
+            "description": "Approval progress of a change the VTA's policy gates on approvals (CONVENTIONS.md §6).",
+            "properties": {
+                "required": {
+                    "type": "integer",
+                    "minimum": 1,
+                    "description": "Distinct approvals the VTA's policy requires."
+                },
+                "received": {
+                    "type": "integer",
+                    "minimum": 0,
+                    "description": "Distinct approvals recorded so far, the initiator's own included."
+                },
+                "approvals": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/$defs/RecordedApproval"
+                    },
+                    "description": "The approvals recorded. Custody projection only; omitted from a response to anyone who is not themselves an eligible approver of this change."
+                },
+                "expiresAt": {
+                    "type": "string",
+                    "format": "date-time",
+                    "description": "When the preview, and every approval bound to it, stops being usable."
+                }
+            }
+        },
+        "RecordedApproval": {
+            "title": "RecordedApproval",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "approver",
+                "evidence"
+            ],
+            "properties": {
+                "approver": {
+                    "type": "string",
+                    "minLength": 1,
+                    "description": "VID of the approver."
+                },
+                "evidence": {
+                    "$ref": "#/$defs/ApprovalEvidenceKind"
+                },
+                "recordedAt": {
+                    "type": "string",
+                    "format": "date-time"
+                }
+            }
+        },
+        "ApprovalEvidenceKind": {
+            "title": "ApprovalEvidenceKind",
+            "type": "string",
+            "enum": [
+                "didSigned",
+                "webauthn",
+                "approverSigned"
+            ],
+            "description": "The evidence an approval was recorded on, as `auth/step-up/approve-response` names it. Only the approver's own evidence is ever recorded: a proof by a key the VTA records as acting for an approver — a console signing key or any other delegation — is never an approval (CONVENTIONS.md §6.3)."
+        },
+        "KeyChangeState": {
+            "title": "KeyChangeState",
+            "type": "string",
+            "enum": [
+                "pendingApproval",
+                "awaitingRecoveryProof",
+                "staged",
+                "overlapping",
+                "completed",
+                "aborted",
+                "expired"
+            ],
+            "description": "`pendingApproval` — awaiting the approvals the VTA's policy requires; nothing is published. `awaitingRecoveryProof` — approved, and waiting for the recovery custodian's proof over the change; nothing is published. `staged` — successor published, not yet used. `overlapping` — successor active, predecessor `retiring`. `completed` — every predecessor retired, or the change is published and any overlap it began has ended. `aborted` — the successor was retired instead of the predecessor, or a revocation superseded the change. `expired` — the approvals or the recovery proof did not arrive before the preview expired; nothing was published."
+        },
+        "KeyChangeKind": {
+            "title": "KeyChangeKind",
+            "type": "string",
+            "enum": [
+                "planned",
+                "compromise",
+                "addition",
+                "recovery"
+            ],
+            "description": "`planned` — a successor was staged, activated, and the predecessor retired on the operator's schedule. `compromise` — a key was revoked and, where the role would otherwise be empty, replaced in the same change. `addition` — a key joined a role without anything leaving it. `recovery` — the identifier's update authority moved to the committed recovery key, because the VTA's own update keys were lost or may be in someone else's hands."
+        },
+        "IdentityKeyRole": {
+            "title": "IdentityKeyRole",
+            "type": "string",
+            "enum": [
+                "attestation",
+                "operational",
+                "messaging",
+                "update",
+                "authenticator"
+            ],
+            "description": "The named key role a key occupies in an identity (CONVENTIONS.md §2; VTI-KEY-070 onward). `attestation` — the only keys in `assertionMethod`; sign the identity's attestation artefacts (credentials, endorsements, status lists) through the VTA's signing service and nowhere else. Generated inside the VTA, never derived, never exportable, never in a backup. `operational` — the only keys the identity's own process uses in `authentication`; sign the node's own traffic (Trust Task requests and responses, DIDComm and TSP signatures, invitations, notices, audit checkpoints). Derived. `messaging` — the only keys in `keyAgreement`; sign nothing. X25519, derived or generated in its own right and never converted from a signing key. `update` — the identifier's change authority as its DID method states it (a did:webvh log's `updateKeys` and `nextKeyHashes`, a KERI key event log's current and next keys); never a role-bound verification method, never in `keyRoles`. Generated inside the VTA, never derived, never exportable, never in a backup, and always accompanied by a committed recovery key held outside the VTA's protection boundary. `authenticator` — a key held on a person's own authenticator (a WebAuthn passkey), listed in `authentication` of that person's identity only; used only to verify the person's WebAuthn assertions (sign-in and step-up evidence) and never to accept a Data Integrity proof. The VTA never holds its private half, so it is enrolled by the passkey ceremony and never generated, added or rotated by these tasks. Never permitted on the durable identity of a VTA, a VTC or a VTN. No role permits `capabilityInvocation` or `capabilityDelegation` (VTI-KEY-075). The set is an extensible registry: a consumer that meets a role it does not implement MUST rely on the key for nothing, and MUST NOT map it onto a role it does know (VTI-KEY-074)."
+        },
+        "IdentityRoleKey": {
+            "title": "IdentityRoleKey",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "role",
+                "keyType",
+                "state"
+            ],
+            "description": "One key in one role. A key is in exactly one role for its whole life; a change of role is a retirement from one and an addition to another, with fresh material under a fresh identifier.",
+            "properties": {
+                "verificationMethod": {
+                    "type": "string",
+                    "minLength": 1,
+                    "description": "The full verification-method identifier (`did#fragment`) the document publishes the key under and lists in `keyRoles`. Absent for `update` keys, which are never role-bound verification methods (VTI-KEY-093). A VTA minting a method SHOULD derive its fragment from the key (VTI-KEY-150)."
+                },
+                "role": {
+                    "$ref": "#/$defs/IdentityKeyRole"
+                },
+                "updateKeyClass": {
+                    "$ref": "#/$defs/UpdateKeyClass"
+                },
+                "relationships": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/$defs/DidVerificationRelationship"
+                    },
+                    "uniqueItems": true,
+                    "description": "The relationships the key is (or, while `pending`, will be) listed in: always exactly its role's one relationship. Empty for `update`, `retired` and `revoked` keys."
+                },
+                "keyType": {
+                    "$ref": "#/$defs/KeyType"
+                },
+                "publicKeyMultibase": {
+                    "type": "string",
+                    "minLength": 1,
+                    "description": "The public half, multibase-encoded, exactly as published. Absent for a `committed` update key, whose public half the identifier has not yet revealed."
+                },
+                "commitment": {
+                    "type": "string",
+                    "minLength": 1,
+                    "description": "For a `committed` update key: the commitment the identifier publishes (a did:webvh `nextKeyHashes` entry, a KERI next-key digest), in the method's own encoding."
+                },
+                "state": {
+                    "$ref": "#/$defs/KeyLifecycleState"
+                },
+                "publishedInVersionId": {
+                    "type": "string",
+                    "description": "The method's version identifier of the change that first published the key or its commitment (method-profiles/: a did:webvh `versionId`, a KERI event's sequence number and digest). Absent while `pending`."
+                },
+                "removedInVersionId": {
+                    "type": "string",
+                    "description": "Version identifier of the change that retired or revoked the key."
+                },
+                "activatesAt": {
+                    "type": "string",
+                    "format": "date-time",
+                    "description": "For a `staged` key: when the VTA will begin using it — no earlier than the publishing change's cache horizon."
+                },
+                "retireAfter": {
+                    "type": "string",
+                    "format": "date-time",
+                    "description": "For a `retiring` key: the end of its overlap. Custody projection only."
+                },
+                "compromisedSince": {
+                    "type": "string",
+                    "format": "date-time",
+                    "description": "For a `revoked` key: the compromise time (VTI-KEY-121), published as the verification method's `revoked` value. Where it cannot be established, the time the key was first published."
+                },
+                "rotationId": {
+                    "type": "string",
+                    "description": "The rotation this key was introduced or retired by."
+                },
+                "label": {
+                    "type": "string",
+                    "maxLength": 256,
+                    "description": "Operator-facing label. Custody projection only."
+                },
+                "custody": {
+                    "$ref": "#/$defs/IdentityKeyCustody"
+                },
+                "ext": {
+                    "$ref": "#/$defs/Ext"
+                }
+            }
+        },
+        "IdentityKeyCustody": {
+            "title": "IdentityKeyCustody",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "exportable",
+                "neverExportable",
+                "inBackups",
+                "protection"
+            ],
+            "description": "How a key is held. Present only in the custody projection. Carries no key material, and a conforming VTA MUST NOT place any in `ext`.",
+            "properties": {
+                "keyId": {
+                    "type": "string",
+                    "minLength": 1,
+                    "description": "The custodian record identifier (`keys/*`'s `keyId`) behind this key. Absent for a key this VTA does not hold (`protection: externalCustodian`)."
+                },
+                "origin": {
+                    "$ref": "#/$defs/KeyOrigin"
+                },
+                "exportable": {
+                    "type": "boolean",
+                    "description": "Whether the custodian would release the private half. Always `false` for `attestation` and `update` keys. Stated explicitly, never absent."
+                },
+                "neverExportable": {
+                    "type": "boolean",
+                    "description": "True when no authority can make the key exportable. `true` implies `exportable: false`."
+                },
+                "inBackups": {
+                    "type": "boolean",
+                    "description": "Whether the key, or material it can be re-derived or decrypted from, is in the VTA's backups or any state transfer. Always `false` for `attestation` and `update` keys (VTI-KEY-112)."
+                },
+                "protection": {
+                    "$ref": "#/$defs/ProtectionClass"
+                },
+                "boundary": {
+                    "type": "string",
+                    "minLength": 1,
+                    "maxLength": 128,
+                    "description": "Opaque, VTA-assigned label of the protection boundary holding the key (CONVENTIONS.md §5.2). Two keys with the same label are lost or compromised together. A recovery update key MUST carry a label different from every routine update key's. Custody projection only; never published."
+                },
+                "destroyed": {
+                    "type": "boolean",
+                    "description": "True once the private half has been destroyed — a retired `attestation` or `messaging` key. The record survives so the key's past signatures stay attributable."
+                }
+            }
+        },
+        "ProtectionClass": {
+            "title": "ProtectionClass",
+            "type": "string",
+            "enum": [
+                "software",
+                "encryptedAtRest",
+                "enclave",
+                "hardwareModule",
+                "externalCustodian"
+            ],
+            "description": "How a private half is protected (CONVENTIONS.md §5.2). `software` — stored by the VTA without encryption independent of the host (a plain VTA). `encryptedAtRest` — wrapped under a key the VTA holds outside its store (a hardened VTA). `enclave` — held only inside an attested trusted execution environment, wrapped under a key released only to its measurement (a TEE VTA). `hardwareModule` — held by a hardware security module or cloud key service that performs the operation without releasing the key. `externalCustodian` — not held by this VTA at all: a recovery update key, or an `authenticator` key on a person's device."
+        },
+        "KeyOrigin": {
+            "title": "KeyOrigin",
+            "type": "string",
+            "enum": [
+                "derived",
+                "imported",
+                "internal"
+            ],
+            "description": "Where the private key came from. `derived` means the maintainer generated it from a seed it holds and can reproduce it from `derivationPath`; `imported` means it arrived from outside and exists only as stored material; `internal` means the maintainer generated it from a CSPRNG and it is reproducible from nothing at all. The distinction is operationally load-bearing: a `derived` key survives a seed restore, an `imported` one is lost unless it was backed up separately, and an `internal` one cannot be recovered by any means once the maintainer's storage is gone. This member is also the only way a consumer can confirm that a `keys/create` request for an `internal` key was honoured rather than silently downgraded to a derived one — see that specification's `internal` member.",
+            "default": "derived"
+        },
+        "KeyLifecycleState": {
+            "title": "KeyLifecycleState",
+            "type": "string",
+            "enum": [
+                "pending",
+                "staged",
+                "active",
+                "retiring",
+                "retired",
+                "revoked",
+                "committed"
+            ],
+            "description": "Where a key is in its role's lifecycle (CONVENTIONS.md §8, §10). `pending` — planned by a preview or a change awaiting approval; not published; custody projection only. `staged` — published and bound to its role but not yet used, until the publishing change's cache horizon. `active` — the key the VTA uses for new signatures (for `messaging`, advertises for new sessions; for `update`, the current authority). `retiring` — still published but never used to sign again; a retiring `messaging` key still decrypts until retirement. `retired` — removed by planned rotation; what it signed while published stays valid, judged against the identifier version current at issuance. `revoked` — withdrawn for compromise, recorded with `compromisedSince`; what it signed from then on establishes nothing. `committed` — an `update` key the identifier commits to as a successor but has not revealed (a did:webvh `nextKeyHashes` entry, a KERI next-key digest). `retired` and `revoked` are terminal."
+        },
+        "DidVerificationRelationship": {
+            "title": "DidVerificationRelationship",
+            "type": "string",
+            "enum": [
+                "authentication",
+                "assertionMethod",
+                "keyAgreement",
+                "capabilityInvocation",
+                "capabilityDelegation"
+            ],
+            "description": "A DID Core verification relationship."
+        },
+        "UpdateKeyClass": {
+            "title": "UpdateKeyClass",
+            "type": "string",
+            "enum": [
+                "routine",
+                "recovery"
+            ],
+            "description": "For an `update` key only (CONVENTIONS.md §5.3). `routine` — generated and held by the VTA, which authorizes the identity's ordinary changes with it. `recovery` — held by a recovery custodian in a protection boundary other than the VTA's; the VTA holds only its commitment, carries that commitment forward in every change it makes, and can use the key only by asking the custodian for a proof (`RecoverySigningRequest`)."
+        },
+        "KeyType": {
+            "title": "KeyType",
+            "type": "string",
+            "enum": [
+                "ed25519",
+                "x25519",
+                "p256",
+                "mldsa44",
+                "mldsa65"
+            ],
+            "description": "Cryptographic algorithm the key material belongs to. `ed25519` signs (EdDSA), `x25519` performs key agreement and never signs, `p256` signs (ES256), and `mldsa44` and `mldsa65` sign with the post-quantum ML-DSA scheme of US NIST FIPS 204. The set is expected to grow as algorithms are standardised, and growing it is a MINOR change under SPEC.md §5.2: `keyType` selects no schema branch, so adding a value relaxes a constraint rather than narrowing one, and the generated libraries mark this enumeration non-exhaustive so that a consumer absorbs a new value rather than failing to compile. Two ML-DSA parameter sets are carried because two specifications require different ones — W3C Quantum-Resistant Cryptosuites defines Data Integrity suites only for ML-DSA-44, while Trust Spanning Protocol Rev 3 §8.1 mandates ML-DSA-65 — so the parameter set is chosen by whatever consumes the key and the two are not redundant. A consumer that does not implement a value it receives MUST refuse the document rather than substitute one it does support."
+        },
+        "IdentityChangePreview": {
+            "title": "IdentityChangePreview",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "previewId",
+                "method",
+                "expiresAt",
+                "changes",
+                "document",
+                "updateKeyRotates"
+            ],
+            "description": "What a change would publish, computed by the VTA by running the handler it would run to apply it (CONVENTIONS.md §6.1). This is what a consent surface renders and what an approval is bound to.",
+            "properties": {
+                "previewId": {
+                    "type": "string",
+                    "minLength": 16,
+                    "description": "Opaque, unguessable identifier of this exact plan. Carried back by the apply request; every approval and any recovery proof is bound to it."
+                },
+                "method": {
+                    "$ref": "#/$defs/DidMethodName"
+                },
+                "baseVersionId": {
+                    "type": "string",
+                    "description": "The version identifier the plan was computed against. Absent only for a creation. The plan is void once the identifier moves past it."
+                },
+                "expiresAt": {
+                    "type": "string",
+                    "format": "date-time"
+                },
+                "changes": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/$defs/IdentityChange"
+                    },
+                    "description": "Every change the plan would make, including the ones the caller did not ask for — in particular any movement of the update authority the method requires."
+                },
+                "document": {
+                    "type": "object",
+                    "description": "The complete identifier document the change would publish, `keyRoles` included. Public data by construction."
+                },
+                "warnings": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/$defs/PreviewWarning"
+                    },
+                    "uniqueItems": true
+                },
+                "updateKeyRotates": {
+                    "type": "boolean",
+                    "description": "True when applying the plan also moves the identifier's update authority to a committed successor — every change under did:webvh pre-rotation, never a KERI interaction event. Stated as its own member because it is the consequence a reviewer most often misses."
+                },
+                "recoverySigning": {
+                    "$ref": "#/$defs/RecoverySigningRequest"
+                }
+            }
+        },
+        "RecoverySigningRequest": {
+            "title": "RecoverySigningRequest",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "commitment",
+                "keyType",
+                "unsignedChange",
+                "proofOptions"
+            ],
+            "description": "What a recovery custodian must sign for a change that only the recovery key may authorize (CONVENTIONS.md §5.4, §9.4). The custodian MUST check `unsignedChange` itself — render it to its human, confirm that it reveals the recovery key it holds and commits to a fresh recovery key it also holds — and MUST NOT sign on the strength of this request's description alone.",
+            "properties": {
+                "commitment": {
+                    "type": "string",
+                    "minLength": 1,
+                    "description": "The recovery commitment the identifier publishes; the custodian's key MUST be the one it commits to."
+                },
+                "keyType": {
+                    "$ref": "#/$defs/KeyType"
+                },
+                "unsignedChange": {
+                    "type": "string",
+                    "minLength": 1,
+                    "description": "The change exactly as it will be published, without the recovery proof, as JSON text in the method's own form (a did:webvh log entry, a KERI rotation event)."
+                },
+                "proofOptions": {
+                    "type": "object",
+                    "description": "The proof the method requires over `unsignedChange`, without its signature value, as the method profile defines it (for did:webvh, a Data Integrity proof configuration with `proofPurpose: assertionMethod` and the recovery key's `did:key` as `verificationMethod`)."
+                },
+                "expiresAt": {
+                    "type": "string",
+                    "format": "date-time"
+                }
+            }
+        },
+        "PreviewWarning": {
+            "title": "PreviewWarning",
+            "type": "string",
+            "enum": [
+                "singleKeyRole",
+                "algorithmNotInAcceptedSet",
+                "roleWillHaveNoClassicalKey",
+                "attestationReissuanceRequired",
+                "selfPublish",
+                "noWitnesses",
+                "protectionBelowPolicy",
+                "recoveryKeyRevealed"
+            ],
+            "description": "Conditions a human should be shown before approving. `singleKeyRole` — the role will hold one active key. `algorithmNotInAcceptedSet` — a verifier population the VTA knows of does not accept the new key's algorithm. `roleWillHaveNoClassicalKey` — every remaining key is post-quantum. `attestationReissuanceRequired` — revoking this attestation key obliges re-issuance and re-signed status lists (VTI-KEY-133). `selfPublish` — the VTA will not publish the change; the operator must. `noWitnesses` — the identifier has no witnesses, so a party holding the VTA's routine update key can drop the recovery commitment unobserved (CONVENTIONS.md §5.3). `protectionBelowPolicy` — a key will be held at a `ProtectionClass` below what the VTA's policy recommends for its role (a plain VTA holding an attestation key). `recoveryKeyRevealed` — this change uses the recovery key, which must be replaced by a fresh recovery commitment in the same change."
+        },
+        "IdentityChange": {
+            "title": "IdentityChange",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "op",
+                "role"
+            ],
+            "properties": {
+                "op": {
+                    "type": "string",
+                    "enum": [
+                        "addKey",
+                        "retireKey",
+                        "revokeKey",
+                        "rotateUpdateKey",
+                        "commitUpdateKey",
+                        "replaceRecoveryCommitment",
+                        "useRecoveryKey"
+                    ],
+                    "description": "`addKey` — a verification method joins its role's relationship and `keyRoles`. `retireKey` — a verification method leaves its relationship, `keyRoles` and the document. `revokeKey` — a verification method leaves its relationship and `keyRoles`, and stays in `verificationMethod` with `revoked` set to the compromise time (CONVENTIONS.md §9.1). `rotateUpdateKey` — the identifier's update authority moves to a committed routine successor. `commitUpdateKey` — a new routine successor is committed. `replaceRecoveryCommitment` — the recovery commitment changes. `useRecoveryKey` — the change is authorized by the recovery key, which the identifier then reveals."
+                },
+                "role": {
+                    "$ref": "#/$defs/IdentityKeyRole"
+                },
+                "verificationMethod": {
+                    "type": "string"
+                },
+                "keyType": {
+                    "$ref": "#/$defs/KeyType"
+                },
+                "publicKeyMultibase": {
+                    "type": "string"
+                },
+                "commitment": {
+                    "type": "string"
+                },
+                "relationships": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/$defs/DidVerificationRelationship"
+                    },
+                    "uniqueItems": true
+                }
+            }
+        },
+        "DidMethodName": {
+            "title": "DidMethodName",
+            "type": "string",
+            "pattern": "^[a-z0-9]+(:[a-z0-9]+)*$",
+            "description": "The DID method an identity uses, as the method profile that governs it is named: `webvh` for a did:webvh identity, `scid:vh` for the did:scid:vh:1 form of one, `webs` for did:webs. Deliberately a pattern and not an enumeration: a method is added by publishing its profile under method-profiles/, never by changing this schema. A VTA MUST refuse a method it holds no profile for, or whose profile declares it ineligible, with `vta/dids:methodNotEligible`."
+        },
+        "KeyChangeOutcome": {
+            "title": "KeyChangeOutcome",
+            "type": "string",
+            "enum": [
+                "preview",
+                "applied",
+                "pendingApproval",
+                "awaitingRecoveryProof"
+            ],
+            "description": "`preview` — nothing was written; the response carries the plan. `applied` — the change was made (and published, unless `publication.selfPublish`). `pendingApproval` — the plan is recorded and awaits further approvals. `awaitingRecoveryProof` — the plan is approved and waits for the recovery custodian's proof (`preview.recoverySigning`); nothing is published until it arrives."
+        }
+    }
+};
+/**
+ * SPEC.md §7.2 policy for the request variant, from this specification's
+ * front matter. Pass to `consumeInbound` — items 5b, 7 and 8 are
+ * per-specification and cannot be derived from the document alone, and
+ * item 2 needs the schema this carries.
+ */
+export const SPEC = {
+    typeUri: TYPE_URI,
+    isBearer: false,
+    isProofRequired: true,
+    isRecipientRequired: true,
+    isIssuedAtRequired: true,
+    payloadSchema: PAYLOAD_SCHEMA,
+};
+/**
+ * SPEC.md §7.2 policy for the success-response variant. `isRecipientRequired`
+ * tracks the *issuer* party's requirement because a response swaps the
+ * parties (§7.3 item 5).
+ */
+export const RESPONSE_SPEC = {
+    typeUri: RESPONSE_TYPE_URI,
+    isBearer: false,
+    isProofRequired: true,
+    isRecipientRequired: true,
+    isIssuedAtRequired: true,
+    payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+};
+//# sourceMappingURL=payload.js.map