{
"components": {
"schemas": {
"AcknowledgePendingKeyRotationRequest": {
"additionalProperties": false,
"properties": {
"rotationSessionId": {
"format": "uuid",
"type": "string"
}
},
"type": "object"
},
"ApproveDeviceIntegrityStepUpRequest": {
"additionalProperties": false,
"properties": {
"proof": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"ApproveEscrowReconstructionRequest": {
"additionalProperties": false,
"properties": {
"approvedAt": {
"format": "date-time",
"type": "string"
},
"approverKeyId": {
"nullable": true,
"type": "string"
},
"signatureBase64": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"ApproverDirectoryEntryResponse": {
"additionalProperties": false,
"properties": {
"approverId": {
"format": "uuid",
"type": "string"
},
"createdAt": {
"format": "date-time",
"type": "string"
},
"credentialType": {
"nullable": true,
"type": "string"
},
"effectiveFrom": {
"format": "date-time",
"type": "string"
},
"effectiveUntil": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"enrolmentAdminId": {
"format": "uuid",
"type": "string"
},
"entryId": {
"nullable": true,
"type": "string"
},
"isQuarantined": {
"type": "boolean"
},
"signingKeyId": {
"nullable": true,
"type": "string"
},
"tenantId": {
"format": "uuid",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"ApproverDirectoryListResponse": {
"additionalProperties": false,
"properties": {
"approvers": {
"items": {
"$ref": "#/components/schemas/ApproverDirectoryEntryResponse"
},
"nullable": true,
"type": "array"
},
"nextCursor": {
"format": "date-time",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"AssistedRecoveryGrantConfirmationLookupRequest": {
"additionalProperties": false,
"properties": {
"organizationId": {
"format": "uuid",
"type": "string"
},
"recoveryTokenRef": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"AssistedRecoveryGrantConfirmationResponse": {
"additionalProperties": false,
"properties": {
"anchorRef": {
"nullable": true,
"type": "string"
},
"attestationMatchesCanonical": {
"type": "boolean"
},
"auditEntryHash": {
"nullable": true,
"type": "string"
},
"auditEntryId": {
"format": "uuid",
"type": "string"
},
"authorisedAt": {
"format": "date-time",
"type": "string"
},
"authorisingAdminId": {
"format": "uuid",
"type": "string"
},
"confirmed": {
"type": "boolean"
},
"enrolmentId": {
"format": "uuid",
"type": "string"
},
"grantScopeAuthoriseOnly": {
"type": "boolean"
},
"grantType": {
"nullable": true,
"type": "string"
},
"noDecryptCapabilityReleased": {
"type": "boolean"
},
"recoveryTokenRef": {
"nullable": true,
"type": "string"
},
"sealVerified": {
"type": "boolean"
},
"subjectUserId": {
"format": "uuid",
"type": "string"
},
"unconfirmedReason": {
"nullable": true,
"type": "string"
},
"zkAttestation": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"AssistedRecoveryGrantResponse": {
"additionalProperties": false,
"properties": {
"anchorRef": {
"nullable": true,
"type": "string"
},
"authorisingAdminId": {
"format": "uuid",
"type": "string"
},
"enrolmentId": {
"format": "uuid",
"type": "string"
},
"issuedAt": {
"format": "date-time",
"type": "string"
},
"recoveryTokenRef": {
"nullable": true,
"type": "string"
},
"scope": {
"nullable": true,
"type": "string"
},
"stepUpAssuranceLevel": {
"nullable": true,
"type": "string"
},
"subjectUserId": {
"format": "uuid",
"type": "string"
},
"zkAttestation": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"AttestPasskeyEnvelopeResponse": {
"additionalProperties": false,
"properties": {
"credentialId": {
"nullable": true,
"type": "string"
},
"enrolledByDeviceRegistrationId": {
"format": "uuid",
"nullable": true,
"type": "string"
},
"outcome": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"AuthHashUpdateRequest": {
"additionalProperties": false,
"properties": {
"breachCheck": {
"nullable": true,
"type": "string"
},
"newAuthDerivationParams": {
"nullable": true,
"type": "string"
},
"newAuthHash": {
"nullable": true,
"type": "string"
},
"passwordPolicyVersion": {
"format": "int32",
"nullable": true,
"type": "integer"
}
},
"type": "object"
},
"BequeathedCredentialItemDto": {
"additionalProperties": false,
"properties": {
"authTag": {
"nullable": true,
"type": "string"
},
"executorKeyRef": {
"nullable": true,
"type": "string"
},
"itemId": {
"nullable": true,
"type": "string"
},
"itemName": {
"nullable": true,
"type": "string"
},
"iv": {
"nullable": true,
"type": "string"
},
"sealedSecret": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"BiometricMismatchAssuranceResponse": {
"additionalProperties": false,
"properties": {
"assuranceRef": {
"nullable": true,
"type": "string"
},
"expiresAt": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"BiometricMismatchRebindResponse": {
"additionalProperties": false,
"properties": {
"assuranceRef": {
"nullable": true,
"type": "string"
},
"deviceName": {
"nullable": true,
"type": "string"
},
"keysRebound": {
"type": "boolean"
},
"previousDeviceName": {
"nullable": true,
"type": "string"
},
"previousDeviceStatus": {
"nullable": true,
"type": "string"
},
"reestablishedAt": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"BreakGlassConsentExportEntry": {
"additionalProperties": false,
"properties": {
"grantee": {
"nullable": true,
"type": "string"
},
"granteeType": {
"nullable": true,
"type": "string"
},
"holderLabel": {
"nullable": true,
"type": "string"
},
"legalBasis": {
"nullable": true,
"type": "string"
},
"purpose": {
"nullable": true,
"type": "string"
},
"recordedAt": {
"nullable": true,
"type": "string"
},
"scope": {
"items": {
"type": "string"
},
"nullable": true,
"type": "array"
},
"status": {
"nullable": true,
"type": "string"
},
"windowEnd": {
"nullable": true,
"type": "string"
},
"windowStart": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"BreakGlassConsentExportResponse": {
"additionalProperties": false,
"properties": {
"article": {
"nullable": true,
"type": "string"
},
"entries": {
"items": {
"$ref": "#/components/schemas/BreakGlassConsentExportEntry"
},
"nullable": true,
"type": "array"
},
"generatedAt": {
"format": "date-time",
"type": "string"
},
"ownerUserId": {
"format": "uuid",
"type": "string"
},
"record": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"BreakGlassConsentListResponse": {
"additionalProperties": false,
"properties": {
"consents": {
"items": {
"$ref": "#/components/schemas/BreakGlassConsentResponse"
},
"nullable": true,
"type": "array"
},
"nextCursor": {
"format": "date-time",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"BreakGlassConsentResponse": {
"additionalProperties": false,
"properties": {
"consentId": {
"nullable": true,
"type": "string"
},
"granteeId": {
"format": "uuid",
"type": "string"
},
"granteeLabel": {
"nullable": true,
"type": "string"
},
"granteeType": {
"nullable": true,
"type": "string"
},
"holderLabel": {
"nullable": true,
"type": "string"
},
"homeRegion": {
"nullable": true,
"type": "string"
},
"legalBasis": {
"nullable": true,
"type": "string"
},
"legalBasisLabel": {
"nullable": true,
"type": "string"
},
"ownerUserId": {
"format": "uuid",
"type": "string"
},
"purpose": {
"nullable": true,
"type": "string"
},
"recordedAt": {
"format": "date-time",
"type": "string"
},
"scopeCategories": {
"items": {
"type": "string"
},
"nullable": true,
"type": "array"
},
"status": {
"nullable": true,
"type": "string"
},
"tenantId": {
"format": "uuid",
"nullable": true,
"type": "string"
},
"windowEnd": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"windowStart": {
"format": "date-time",
"type": "string"
},
"withdrawalReason": {
"nullable": true,
"type": "string"
},
"withdrawnAt": {
"format": "date-time",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"BreakGlassGrantedConsentListResponse": {
"additionalProperties": false,
"properties": {
"consents": {
"items": {
"$ref": "#/components/schemas/BreakGlassConsentResponse"
},
"nullable": true,
"type": "array"
},
"nextCursor": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"unreachableRegions": {
"items": {
"type": "string"
},
"nullable": true,
"type": "array"
}
},
"type": "object"
},
"CancelMergeRewrapRequestBody": {
"additionalProperties": false,
"description": "Body for the cancel action.",
"properties": {
"reason": {
"description": "Why the task was cancelled, in words a member and an auditor can both read.",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"ChangePasswordRequest": {
"additionalProperties": false,
"properties": {
"authHashUpdate": {
"$ref": "#/components/schemas/AuthHashUpdateRequest"
},
"authTag": {
"nullable": true,
"type": "string"
},
"iv": {
"nullable": true,
"type": "string"
},
"kdf": {
"$ref": "#/components/schemas/KdfParametersRequest"
},
"wrappedUmk": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"ChangePasswordResponse": {
"additionalProperties": false,
"properties": {
"requestedAt": {
"format": "date-time",
"type": "string"
},
"sagaId": {
"format": "uuid",
"type": "string"
},
"status": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"CheckpointMergeRewrapRequest": {
"additionalProperties": false,
"properties": {
"checkpointData": {
"nullable": true,
"type": "string"
},
"deviceId": {
"nullable": true,
"type": "string"
},
"rewrappedItems": {
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"CheckpointRotationRequest": {
"additionalProperties": false,
"properties": {
"checkpointData": {
"nullable": true,
"type": "string"
},
"rotatedItems": {
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"ClaimMergeRewrapRequest": {
"additionalProperties": false,
"properties": {
"deviceId": {
"nullable": true,
"type": "string"
},
"leaseMinutes": {
"format": "int32",
"nullable": true,
"type": "integer"
}
},
"type": "object"
},
"CompleteKeyRotationRequest": {
"additionalProperties": false,
"properties": {
"newGenerationEnvelope": {
"$ref": "#/components/schemas/RotationEnvelopeRequest"
},
"passkeyRewraps": {
"items": {
"$ref": "#/components/schemas/RotationPasskeyRewrapRequest"
},
"nullable": true,
"type": "array"
}
},
"type": "object"
},
"CompleteMergeRewrapRequest": {
"additionalProperties": false,
"properties": {
"deviceId": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"CompletePairingRequest": {
"additionalProperties": false,
"properties": {
"approvedJoinerSigningKeyThumbprint": {
"nullable": true,
"type": "string"
},
"wrappedMasterKey": {
"example": "base64(RSA-OAEP-256(masterKey)) — e.g. \"9f0e1d2c…\" (truncated)",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"ConductExecutorRehearsalRequest": {
"additionalProperties": false,
"properties": {
"depth": {
"nullable": true,
"type": "string"
},
"enrolmentId": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"ConfigureEscrowRequest": {
"additionalProperties": false,
"properties": {
"enrolmentId": {
"nullable": true,
"type": "string"
},
"fingerprint": {
"nullable": true,
"type": "string"
},
"shares": {
"items": {
"$ref": "#/components/schemas/ConfigureEscrowShareEnvelope"
},
"nullable": true,
"type": "array"
},
"threshold": {
"format": "int32",
"type": "integer"
},
"totalShares": {
"format": "int32",
"type": "integer"
},
"wrappedVaultKeys": {
"items": {
"$ref": "#/components/schemas/ConfigureEscrowVaultKeyWrap"
},
"nullable": true,
"type": "array"
}
},
"type": "object"
},
"ConfigureEscrowShareEnvelope": {
"additionalProperties": false,
"properties": {
"ciphertext": {
"format": "byte",
"nullable": true,
"type": "string"
},
"holderId": {
"nullable": true,
"type": "string"
},
"holderType": {
"nullable": true,
"type": "string"
},
"role": {
"nullable": true,
"type": "string"
},
"shareIndex": {
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"ConfigureEscrowVaultKeyWrap": {
"additionalProperties": false,
"properties": {
"aad": {
"nullable": true,
"type": "string"
},
"authTag": {
"format": "byte",
"nullable": true,
"type": "string"
},
"ciphertext": {
"format": "byte",
"nullable": true,
"type": "string"
},
"nonce": {
"format": "byte",
"nullable": true,
"type": "string"
},
"vaultCategory": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"ConfirmPairingRequest": {
"additionalProperties": false,
"properties": {
"deviceId": {
"format": "uuid",
"type": "string"
},
"fingerprintConfirmed": {
"type": "boolean"
},
"sasConfirmation": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"CreatePairingSessionRequest": {
"additionalProperties": false,
"properties": {
"challenge": {
"example": "2d7e4a5b8f1c3d6e9a0b7c4d1e8f5a2b3c6d9e0f1a2b5c8d",
"nullable": true,
"type": "string"
},
"deviceAId": {
"example": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
"format": "uuid",
"type": "string"
},
"deviceAPublicKey": {
"example": "{\"kty\":\"RSA\",\"n\":\"0vx7agoebGcQSuuPiLJXZpt...\",\"e\":\"AQAB\",\"alg\":\"RSA-OAEP-256\",\"key_ops\":[\"encrypt\"]}",
"nullable": true,
"type": "string"
},
"expiresAt": {
"example": "2025-10-14T15:15:00.0000000+00:00",
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"CreateWrappedUmkEnvelopeRequest": {
"additionalProperties": false,
"properties": {
"authTag": {
"nullable": true,
"type": "string"
},
"iv": {
"nullable": true,
"type": "string"
},
"kdf": {
"$ref": "#/components/schemas/KdfParametersRequest"
},
"passkeyBindingToken": {
"nullable": true,
"type": "string"
},
"passkeyCredentialId": {
"nullable": true,
"type": "string"
},
"wrappedUmk": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"CreateWrappedUmkEnvelopeResponse": {
"additionalProperties": false,
"properties": {
"createdAt": {
"format": "date-time",
"type": "string"
},
"version": {
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"CredentialResponderRequest": {
"additionalProperties": false,
"properties": {
"responderClass": {
"nullable": true,
"type": "string"
},
"responderId": {
"format": "uuid",
"type": "string"
},
"tenantId": {
"format": "uuid",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"CredentialedResponderSummary": {
"additionalProperties": false,
"properties": {
"credentialedAt": {
"format": "date-time",
"type": "string"
},
"responderClass": {
"nullable": true,
"type": "string"
},
"responderId": {
"format": "uuid",
"type": "string"
},
"revokedAt": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"status": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"CurrentKeyGenerationResponse": {
"additionalProperties": false,
"properties": {
"currentGeneration": {
"nullable": true,
"type": "string"
},
"pendingRotationSessionId": {
"format": "uuid",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"DenyEscrowReconstructionRequest": {
"additionalProperties": false,
"properties": {
"reason": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"DeprovisionApproverResult": {
"additionalProperties": false,
"properties": {
"approverId": {
"format": "uuid",
"type": "string"
},
"quorumsReverted": {
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"DeviceChallengeResponse": {
"additionalProperties": false,
"properties": {
"challengeId": {
"format": "uuid",
"type": "string"
},
"deviceRegistrationId": {
"format": "uuid",
"type": "string"
},
"expiresAt": {
"format": "date-time",
"type": "string"
},
"nonce": {
"nullable": true,
"type": "string"
},
"purpose": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"DeviceIntegrityResponse": {
"additionalProperties": false,
"properties": {
"appAttestRiskMetric": {
"format": "int32",
"nullable": true,
"type": "integer"
},
"appAttestRiskMetricReadAt": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"change": {
"nullable": true,
"type": "string"
},
"deviceRegistrationId": {
"format": "uuid",
"type": "string"
},
"observed": {
"type": "boolean"
},
"observedAt": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"platform": {
"nullable": true,
"type": "string"
},
"posture": {
"nullable": true,
"type": "string"
},
"postureReason": {
"nullable": true,
"type": "string"
},
"priorVerdict": {
"nullable": true,
"type": "string"
},
"reason": {
"nullable": true,
"type": "string"
},
"stale": {
"type": "boolean"
},
"verdict": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"DeviceIntegrityStepUpListResponse": {
"additionalProperties": false,
"properties": {
"requests": {
"items": {
"$ref": "#/components/schemas/DeviceIntegrityStepUpResponse"
},
"nullable": true,
"type": "array"
}
},
"type": "object"
},
"DeviceIntegrityStepUpResponse": {
"additionalProperties": false,
"properties": {
"bodyDigest": {
"nullable": true,
"type": "string"
},
"createdAt": {
"format": "date-time",
"type": "string"
},
"decidedByDeviceRegistrationId": {
"format": "uuid",
"nullable": true,
"type": "string"
},
"expiresAt": {
"format": "date-time",
"type": "string"
},
"method": {
"nullable": true,
"type": "string"
},
"path": {
"nullable": true,
"type": "string"
},
"peerProof": {
"nullable": true,
"type": "string"
},
"requestingDeviceName": {
"nullable": true,
"type": "string"
},
"requestingDeviceRegistrationId": {
"format": "uuid",
"type": "string"
},
"status": {
"nullable": true,
"type": "string"
},
"stepUpRequestId": {
"format": "uuid",
"type": "string"
}
},
"type": "object"
},
"DeviceKeyExchangeKeyRotationResponse": {
"additionalProperties": false,
"properties": {
"deviceRegistrationId": {
"format": "uuid",
"type": "string"
},
"publicKeyFingerprint": {
"nullable": true,
"type": "string"
},
"rotatedAt": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"DeviceRegistrationResponse": {
"additionalProperties": false,
"properties": {
"deviceId": {
"nullable": true,
"type": "string"
},
"deviceName": {
"nullable": true,
"type": "string"
},
"deviceType": {
"nullable": true,
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"isActive": {
"type": "boolean"
},
"lastSeenAt": {
"format": "date-time",
"type": "string"
},
"publicKey": {
"nullable": true,
"type": "string"
},
"registeredAt": {
"format": "date-time",
"type": "string"
},
"signingKeyEnrolledAt": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"signingKeyEnrolmentMethod": {
"nullable": true,
"type": "string"
},
"signingKeyThumbprint": {
"nullable": true,
"type": "string"
},
"suspectedLostAt": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"suspectedLostRecoverySessionId": {
"format": "uuid",
"nullable": true,
"type": "string"
},
"userId": {
"format": "uuid",
"type": "string"
}
},
"type": "object"
},
"DeviceRegistrationResponseCursorResult": {
"additionalProperties": false,
"properties": {
"hasMore": {
"type": "boolean"
},
"items": {
"items": {
"$ref": "#/components/schemas/DeviceRegistrationResponse"
},
"nullable": true,
"type": "array"
},
"nextCursor": {
"nullable": true,
"type": "string"
},
"pageSize": {
"format": "int32",
"type": "integer"
},
"previousCursor": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"DeviceSigningKeyLookupRequest": {
"additionalProperties": false,
"properties": {
"keyThumbprint": {
"nullable": true,
"type": "string"
},
"userId": {
"format": "uuid",
"type": "string"
}
},
"type": "object"
},
"DeviceSigningKeyLookupResponse": {
"additionalProperties": false,
"properties": {
"deviceRegistrationId": {
"format": "uuid",
"nullable": true,
"type": "string"
},
"found": {
"type": "boolean"
},
"keyThumbprint": {
"nullable": true,
"type": "string"
},
"publicJwk": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"DeviceSyncStatusResponse": {
"additionalProperties": false,
"properties": {
"deviceId": {
"format": "uuid",
"type": "string"
},
"isOnline": {
"type": "boolean"
},
"keyGeneration": {
"format": "int32",
"type": "integer"
},
"lastSyncedAt": {
"format": "date-time",
"type": "string"
},
"pendingUpdates": {
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"EakEnrolmentResponse": {
"additionalProperties": false,
"properties": {
"createdAt": {
"format": "date-time",
"type": "string"
},
"escrowKeyFingerprint": {
"nullable": true,
"type": "string"
},
"expiresAt": {
"format": "date-time",
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"isEnabled": {
"type": "boolean"
},
"jurisdiction": {
"nullable": true,
"type": "string"
},
"revocationReason": {
"nullable": true,
"type": "string"
},
"revokedAt": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"shares": {
"items": {
"$ref": "#/components/schemas/EakShareCustodySummary"
},
"nullable": true,
"type": "array"
},
"threshold": {
"format": "int32",
"type": "integer"
},
"totalShares": {
"format": "int32",
"type": "integer"
},
"updatedAt": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"userId": {
"format": "uuid",
"type": "string"
},
"vaultCategory": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"EakRotationDeferralResponse": {
"additionalProperties": false,
"properties": {
"anchorReference": {
"nullable": true,
"type": "string"
},
"deferralCount": {
"format": "int32",
"type": "integer"
},
"deferredAt": {
"format": "date-time",
"type": "string"
},
"deferredUntil": {
"format": "date-time",
"type": "string"
},
"exposedAt": {
"format": "date-time",
"type": "string"
},
"obligationId": {
"format": "uuid",
"type": "string"
}
},
"type": "object"
},
"EakRotationObligationResponse": {
"additionalProperties": false,
"properties": {
"canDefer": {
"type": "boolean"
},
"cause": {
"nullable": true,
"type": "string"
},
"deferredUntil": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"exposedAt": {
"format": "date-time",
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"nextDueAt": {
"format": "date-time",
"type": "string"
},
"reSurfaceDays": {
"format": "int32",
"type": "integer"
},
"sessionId": {
"format": "uuid",
"type": "string"
}
},
"type": "object"
},
"EakShareCustodySummary": {
"additionalProperties": false,
"properties": {
"createdAt": {
"format": "date-time",
"type": "string"
},
"holderOrgId": {
"format": "uuid",
"nullable": true,
"type": "string"
},
"holderRole": {
"nullable": true,
"type": "string"
},
"holderType": {
"nullable": true,
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"publicKeyFingerprint": {
"nullable": true,
"type": "string"
},
"revokedAt": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"shareIndex": {
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"EmergencyAccessAnchorResponse": {
"additionalProperties": false,
"properties": {
"actorRef": {
"nullable": true,
"type": "string"
},
"anchorId": {
"format": "uuid",
"type": "string"
},
"blockchainAnchorId": {
"nullable": true,
"type": "string"
},
"configRef": {
"nullable": true,
"type": "string"
},
"occurredOn": {
"format": "date-time",
"type": "string"
},
"originInstanceId": {
"format": "uuid",
"type": "string"
},
"phase": {
"nullable": true,
"type": "string"
},
"recordedAt": {
"format": "date-time",
"type": "string"
},
"requesterOrgRef": {
"nullable": true,
"type": "string"
},
"requesterRef": {
"nullable": true,
"type": "string"
},
"sessionRef": {
"nullable": true,
"type": "string"
},
"subjectRef": {
"nullable": true,
"type": "string"
},
"urgency": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"EmergencyAccessAnchorResponseCursorResult": {
"additionalProperties": false,
"properties": {
"hasMore": {
"type": "boolean"
},
"items": {
"items": {
"$ref": "#/components/schemas/EmergencyAccessAnchorResponse"
},
"nullable": true,
"type": "array"
},
"nextCursor": {
"nullable": true,
"type": "string"
},
"pageSize": {
"format": "int32",
"type": "integer"
},
"previousCursor": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"EmergencyAccessReleaseHistoryResponse": {
"additionalProperties": false,
"properties": {
"events": {
"items": {
"$ref": "#/components/schemas/EmergencyAccessReleaseRecordDto"
},
"nullable": true,
"type": "array"
},
"generatedAt": {
"format": "date-time",
"type": "string"
},
"subjectUserId": {
"format": "uuid",
"type": "string"
}
},
"type": "object"
},
"EmergencyAccessReleaseRecordDto": {
"additionalProperties": false,
"properties": {
"anchorRef": {
"nullable": true,
"type": "string"
},
"approvalChain": {
"items": {
"type": "string"
},
"nullable": true,
"type": "array"
},
"eventId": {
"format": "uuid",
"type": "string"
},
"evidenceHash": {
"nullable": true,
"type": "string"
},
"fieldsReleased": {
"items": {
"type": "string"
},
"nullable": true,
"type": "array"
},
"grantEndedAt": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"invokerLabel": {
"nullable": true,
"type": "string"
},
"occurredAt": {
"format": "date-time",
"type": "string"
},
"outcome": {
"nullable": true,
"type": "string"
},
"releasePath": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"EmergencyCardReadResponse": {
"additionalProperties": false,
"properties": {
"anchorId": {
"nullable": true,
"type": "string"
},
"anchoredHash": {
"nullable": true,
"type": "string"
},
"notifiedRecipientCount": {
"format": "int32",
"type": "integer"
},
"occurredAt": {
"format": "date-time",
"type": "string"
},
"readEventId": {
"format": "uuid",
"type": "string"
}
},
"type": "object"
},
"EnrolApproverRequest": {
"additionalProperties": false,
"properties": {
"approverId": {
"format": "uuid",
"type": "string"
},
"attestation": {
"nullable": true,
"type": "string"
},
"credentialPin": {
"nullable": true,
"type": "string"
},
"credentialType": {
"nullable": true,
"type": "string"
},
"effectiveFrom": {
"format": "date-time",
"type": "string"
},
"effectiveUntil": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"tenantId": {
"format": "uuid",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"EnrolDeviceSigningKeyRequest": {
"additionalProperties": false,
"properties": {
"enrolmentProof": {
"nullable": true,
"type": "string"
},
"pairingSessionId": {
"format": "uuid",
"nullable": true,
"type": "string"
},
"recoveryEnrolmentTicket": {
"nullable": true,
"type": "string"
},
"signingKeyJwk": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"EnrolDuressEnvelopeRequest": {
"additionalProperties": false,
"properties": {
"authTag": {
"nullable": true,
"type": "string"
},
"behaviourAcknowledgementVersion": {
"nullable": true,
"type": "string"
},
"iv": {
"nullable": true,
"type": "string"
},
"kdf": {
"$ref": "#/components/schemas/KdfParametersRequest"
},
"manifestAuthTag": {
"nullable": true,
"type": "string"
},
"manifestIv": {
"nullable": true,
"type": "string"
},
"sealedManifest": {
"nullable": true,
"type": "string"
},
"wrappedUmk": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"EnrolEakRequest": {
"additionalProperties": false,
"properties": {
"escrowKeyFingerprint": {
"nullable": true,
"type": "string"
},
"expiresAt": {
"format": "date-time",
"type": "string"
},
"jurisdiction": {
"nullable": true,
"type": "string"
},
"shares": {
"items": {
"$ref": "#/components/schemas/EnrolEakShareRequest"
},
"nullable": true,
"type": "array"
},
"threshold": {
"format": "int32",
"type": "integer"
},
"totalShares": {
"format": "int32",
"type": "integer"
},
"vaultCategory": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"EnrolEakShareRequest": {
"additionalProperties": false,
"properties": {
"encryptedShare": {
"format": "byte",
"nullable": true,
"type": "string"
},
"holderOrgId": {
"format": "uuid",
"nullable": true,
"type": "string"
},
"holderRole": {
"nullable": true,
"type": "string"
},
"holderType": {
"nullable": true,
"type": "string"
},
"publicKeyFingerprint": {
"nullable": true,
"type": "string"
},
"shareIndex": {
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"EnrolFallbackRecoveryCodeRequest": {
"additionalProperties": false,
"properties": {
"recoveryCode": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"EnrolRecoveryPhraseEnvelopeRequest": {
"additionalProperties": false,
"properties": {
"authTag": {
"nullable": true,
"type": "string"
},
"iv": {
"nullable": true,
"type": "string"
},
"phraseSalt": {
"nullable": true,
"type": "string"
},
"wrappedUmk": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"EnrolResponderHolderRequest": {
"additionalProperties": false,
"properties": {
"credentialedClasses": {
"items": {
"type": "string"
},
"nullable": true,
"type": "array"
},
"holderRole": {
"nullable": true,
"type": "string"
},
"organisationId": {
"format": "uuid",
"type": "string"
},
"tenantId": {
"format": "uuid",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"EnrollPasskeyEnvelopeRequest": {
"additionalProperties": false,
"properties": {
"authTag": {
"nullable": true,
"type": "string"
},
"iv": {
"nullable": true,
"type": "string"
},
"passkeyBindingToken": {
"nullable": true,
"type": "string"
},
"passkeyCredentialId": {
"nullable": true,
"type": "string"
},
"prfInput": {
"nullable": true,
"type": "string"
},
"wrappedUmk": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"EscrowAuditChainResponse": {
"additionalProperties": false,
"properties": {
"entries": {
"items": {
"$ref": "#/components/schemas/EscrowAuditEntryDto"
},
"nullable": true,
"type": "array"
},
"hasMore": {
"type": "boolean"
},
"headHash": {
"nullable": true,
"type": "string"
},
"nextCursor": {
"nullable": true,
"type": "string"
},
"pageSize": {
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"EscrowAuditChainVerificationResponse": {
"additionalProperties": false,
"properties": {
"entriesChecked": {
"format": "int32",
"type": "integer"
},
"failureReason": {
"nullable": true,
"type": "string"
},
"firstFailureEntryId": {
"format": "uuid",
"nullable": true,
"type": "string"
},
"firstFailureIndex": {
"format": "int32",
"nullable": true,
"type": "integer"
},
"isValid": {
"type": "boolean"
}
},
"type": "object"
},
"EscrowAuditEntryDto": {
"additionalProperties": false,
"properties": {
"action": {
"nullable": true,
"type": "string"
},
"actorId": {
"format": "uuid",
"type": "string"
},
"blockchainAnchorId": {
"nullable": true,
"type": "string"
},
"enrolmentId": {
"format": "uuid",
"nullable": true,
"type": "string"
},
"entryHash": {
"nullable": true,
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"occurredAt": {
"format": "date-time",
"type": "string"
},
"payloadJson": {
"nullable": true,
"type": "string"
},
"previousHash": {
"nullable": true,
"type": "string"
},
"requestId": {
"format": "uuid",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"EscrowEnrolmentStatusResponse": {
"additionalProperties": false,
"properties": {
"attestationStaleUnverified": {
"type": "boolean"
},
"belowReconstructionThresholdForDisplay": {
"type": "boolean"
},
"createdAt": {
"format": "date-time",
"type": "string"
},
"displayAvailableHolderCount": {
"format": "int32",
"type": "integer"
},
"enrolmentId": {
"nullable": true,
"type": "string"
},
"fingerprint": {
"nullable": true,
"type": "string"
},
"freshnessWindowDays": {
"format": "int32",
"type": "integer"
},
"holders": {
"items": {
"$ref": "#/components/schemas/EscrowShareHolderSummary"
},
"nullable": true,
"type": "array"
},
"revocationReason": {
"nullable": true,
"type": "string"
},
"revokedAt": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"status": {
"nullable": true,
"type": "string"
},
"threshold": {
"format": "int32",
"type": "integer"
},
"totalShares": {
"format": "int32",
"type": "integer"
},
"updatedAt": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"userId": {
"format": "uuid",
"type": "string"
},
"vaultCategories": {
"items": {
"type": "string"
},
"nullable": true,
"type": "array"
}
},
"type": "object"
},
"EscrowReconstructionHolderDto": {
"additionalProperties": false,
"properties": {
"holderId": {
"nullable": true,
"type": "string"
},
"holderType": {
"nullable": true,
"type": "string"
},
"role": {
"nullable": true,
"type": "string"
},
"shareIndex": {
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"EscrowReconstructionJustificationResponse": {
"additionalProperties": false,
"properties": {
"justification": {
"nullable": true,
"type": "string"
},
"readerRole": {
"nullable": true,
"type": "string"
},
"requestId": {
"format": "uuid",
"type": "string"
},
"state": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"EscrowReconstructionLifecycleResponse": {
"additionalProperties": false,
"properties": {
"accessExpiresAt": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"accessExtensionChallengeNonce": {
"nullable": true,
"type": "string"
},
"accessExtensionCount": {
"format": "int32",
"type": "integer"
},
"accessWindowCeiling": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"approvalChallengeNonce": {
"nullable": true,
"type": "string"
},
"approvalCount": {
"format": "int32",
"type": "integer"
},
"earliestUnlockAt": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"enrolmentId": {
"nullable": true,
"type": "string"
},
"expiresAt": {
"format": "date-time",
"type": "string"
},
"requestId": {
"format": "uuid",
"type": "string"
},
"shareSubmissionCount": {
"format": "int32",
"type": "integer"
},
"status": {
"nullable": true,
"type": "string"
},
"updatedAt": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"zeroizationSignalledAt": {
"format": "date-time",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"EscrowReconstructionMaterialResponse": {
"additionalProperties": false,
"properties": {
"accessExpiresAt": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"enrolmentId": {
"format": "uuid",
"type": "string"
},
"holders": {
"items": {
"$ref": "#/components/schemas/EscrowReconstructionHolderDto"
},
"nullable": true,
"type": "array"
},
"requestId": {
"format": "uuid",
"type": "string"
},
"threshold": {
"format": "int32",
"type": "integer"
},
"totalShares": {
"format": "int32",
"type": "integer"
},
"vaultKeyWraps": {
"items": {
"$ref": "#/components/schemas/EscrowVaultKeyWrapDto"
},
"nullable": true,
"type": "array"
}
},
"type": "object"
},
"EscrowReconstructionRequestResponse": {
"additionalProperties": false,
"properties": {
"approvalChallengeNonce": {
"nullable": true,
"type": "string"
},
"enrolmentId": {
"nullable": true,
"type": "string"
},
"expiresAt": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"requestId": {
"format": "uuid",
"type": "string"
},
"requestedAt": {
"format": "date-time",
"type": "string"
},
"status": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"EscrowRequesterClosedRequestDto": {
"additionalProperties": false,
"properties": {
"expiresAt": {
"format": "date-time",
"type": "string"
},
"requestId": {
"format": "uuid",
"type": "string"
},
"requestedAt": {
"format": "date-time",
"type": "string"
},
"status": {
"nullable": true,
"type": "string"
},
"subjectUserId": {
"format": "uuid",
"type": "string"
}
},
"type": "object"
},
"EscrowRequesterClosedRequestsResponse": {
"additionalProperties": false,
"properties": {
"requests": {
"items": {
"$ref": "#/components/schemas/EscrowRequesterClosedRequestDto"
},
"nullable": true,
"type": "array"
}
},
"type": "object"
},
"EscrowRequesterOpenRequestDto": {
"additionalProperties": false,
"properties": {
"earliestUnlockAt": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"expiresAt": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"homeRegion": {
"nullable": true,
"type": "string"
},
"requestId": {
"format": "uuid",
"type": "string"
},
"requestedAt": {
"format": "date-time",
"type": "string"
},
"status": {
"nullable": true,
"type": "string"
},
"subjectUserId": {
"format": "uuid",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"EscrowRequesterOpenRequestsResponse": {
"additionalProperties": false,
"properties": {
"requests": {
"items": {
"$ref": "#/components/schemas/EscrowRequesterOpenRequestDto"
},
"nullable": true,
"type": "array"
}
},
"type": "object"
},
"EscrowShareHolderSummary": {
"additionalProperties": false,
"properties": {
"attestationStaleUnverified": {
"type": "boolean"
},
"hasHsmCustody": {
"type": "boolean"
},
"holderId": {
"nullable": true,
"type": "string"
},
"holderType": {
"nullable": true,
"type": "string"
},
"role": {
"nullable": true,
"type": "string"
},
"shareIndex": {
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"EscrowShareSubmissionDto": {
"additionalProperties": false,
"properties": {
"holderId": {
"nullable": true,
"type": "string"
},
"rewrapCiphertextBase64": {
"nullable": true,
"type": "string"
},
"shareIndex": {
"format": "int32",
"type": "integer"
},
"submittedAt": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"EscrowShareSubmissionsResponse": {
"additionalProperties": false,
"properties": {
"accessExpiresAt": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"earliestUnlockAt": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"requestId": {
"format": "uuid",
"type": "string"
},
"status": {
"nullable": true,
"type": "string"
},
"submissions": {
"items": {
"$ref": "#/components/schemas/EscrowShareSubmissionDto"
},
"nullable": true,
"type": "array"
}
},
"type": "object"
},
"EscrowVaultKeyWrapDto": {
"additionalProperties": false,
"properties": {
"aad": {
"nullable": true,
"type": "string"
},
"authTagBase64": {
"nullable": true,
"type": "string"
},
"ciphertextBase64": {
"nullable": true,
"type": "string"
},
"nonceBase64": {
"nullable": true,
"type": "string"
},
"vaultCategory": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"ExecutorBequestItemSummaryResponse": {
"additionalProperties": false,
"properties": {
"itemId": {
"nullable": true,
"type": "string"
},
"itemName": {
"nullable": true,
"type": "string"
},
"lastRevealedAt": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"revealCount": {
"format": "int32",
"type": "integer"
},
"status": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"ExecutorBequestSummaryResponse": {
"additionalProperties": false,
"properties": {
"bequestId": {
"format": "uuid",
"type": "string"
},
"donorUserId": {
"format": "uuid",
"type": "string"
},
"items": {
"items": {
"$ref": "#/components/schemas/ExecutorBequestItemSummaryResponse"
},
"nullable": true,
"type": "array"
},
"releasedAt": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"status": {
"nullable": true,
"type": "string"
},
"triggerLabel": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"ExecutorRehearsalResponse": {
"additionalProperties": false,
"properties": {
"anchorRef": {
"nullable": true,
"type": "string"
},
"assertion": {
"nullable": true,
"type": "string"
},
"conductedAt": {
"format": "date-time",
"type": "string"
},
"dataReleased": {
"type": "boolean"
},
"depth": {
"nullable": true,
"type": "string"
},
"enrolmentId": {
"format": "uuid",
"type": "string"
},
"gateResults": {
"items": {
"$ref": "#/components/schemas/RehearsalGateResultDto"
},
"nullable": true,
"type": "array"
},
"isReady": {
"type": "boolean"
},
"readinessGapCount": {
"format": "int32",
"type": "integer"
},
"readinessPassCount": {
"format": "int32",
"type": "integer"
},
"runType": {
"nullable": true,
"type": "string"
},
"simulatedActor": {
"type": "boolean"
},
"umkUnwrapped": {
"type": "boolean"
}
},
"type": "object"
},
"FallbackRecoveryEnrolmentResponse": {
"additionalProperties": false,
"properties": {
"enrolledAt": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"GetRecoveryPhraseEnvelopeResponse": {
"additionalProperties": false,
"properties": {
"envelope": {
"$ref": "#/components/schemas/WrappedUmkEnvelopeDto"
}
},
"type": "object"
},
"GetWrappedUmkEnvelopeResponse": {
"additionalProperties": false,
"properties": {
"currentGeneration": {
"nullable": true,
"type": "string"
},
"envelopes": {
"items": {
"$ref": "#/components/schemas/WrappedUmkEnvelopeDto"
},
"nullable": true,
"type": "array"
},
"pendingRotation": {
"$ref": "#/components/schemas/PendingRotationEnvelopeDto"
}
},
"type": "object"
},
"InitiateKeyRotationRequest": {
"additionalProperties": false,
"properties": {
"deviceId": {
"nullable": true,
"type": "string"
},
"totalItems": {
"format": "int32",
"type": "integer"
},
"trigger": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"InitiateRecoverySessionRequest": {
"additionalProperties": false,
"properties": {
"configId": {
"format": "uuid",
"nullable": true,
"type": "string"
},
"reason": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"IssueAssistedRecoveryAuthorizationRequest": {
"additionalProperties": false,
"properties": {
"enrolmentId": {
"format": "uuid",
"type": "string"
},
"proofingEvidenceRef": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"IssueDeviceChallengeRequest": {
"additionalProperties": false,
"properties": {
"purpose": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"KdfParametersDto": {
"additionalProperties": false,
"properties": {
"algorithm": {
"nullable": true,
"type": "string"
},
"iterations": {
"format": "int32",
"type": "integer"
},
"salt": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"KdfParametersRequest": {
"additionalProperties": false,
"properties": {
"algorithm": {
"nullable": true,
"type": "string"
},
"calibrationMode": {
"format": "int32",
"type": "integer"
},
"iterations": {
"format": "int32",
"type": "integer"
},
"salt": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"KeyCustodyIntegrityDecisionRequest": {
"additionalProperties": false,
"properties": {
"bodySha256": {
"nullable": true,
"type": "string"
},
"deviceProof": {
"nullable": true,
"type": "string"
},
"method": {
"nullable": true,
"type": "string"
},
"path": {
"nullable": true,
"type": "string"
},
"peerProof": {
"nullable": true,
"type": "string"
},
"possessionRefusesUnverified": {
"type": "boolean"
},
"skipIntegrity": {
"type": "boolean"
},
"verifyPossession": {
"type": "boolean"
}
},
"type": "object"
},
"KeyCustodyIntegrityDecisionResponse": {
"additionalProperties": false,
"properties": {
"evaluated": {
"type": "boolean"
},
"indeterminate": {
"type": "boolean"
},
"outcome": {
"nullable": true,
"type": "string"
},
"peerOutcome": {
"nullable": true,
"type": "string"
},
"possession": {
"$ref": "#/components/schemas/KeyCustodyPossessionVerdict"
},
"posture": {
"nullable": true,
"type": "string"
},
"stale": {
"type": "boolean"
},
"stepUpDeviceRegistrationIds": {
"items": {
"format": "uuid",
"type": "string"
},
"nullable": true,
"type": "array"
}
},
"type": "object"
},
"KeyCustodyPossessionVerdict": {
"additionalProperties": false,
"properties": {
"deviceRegistrationId": {
"format": "uuid",
"nullable": true,
"type": "string"
},
"outcome": {
"nullable": true,
"type": "string"
},
"verified": {
"type": "boolean"
}
},
"type": "object"
},
"KeyRotationObligationResponse": {
"additionalProperties": false,
"properties": {
"disposition": {
"nullable": true,
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"removedAt": {
"format": "date-time",
"type": "string"
},
"removedDeviceId": {
"format": "uuid",
"type": "string"
},
"removedDeviceName": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"KeyRotationSessionResponse": {
"additionalProperties": false,
"properties": {
"carriedPasskeyCount": {
"format": "int32",
"nullable": true,
"type": "integer"
},
"checkpointData": {
"nullable": true,
"type": "string"
},
"completedAt": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"coverageConfirmed": {
"type": "boolean"
},
"coveredItemCount": {
"format": "int32",
"nullable": true,
"type": "integer"
},
"deviceId": {
"nullable": true,
"type": "string"
},
"dualKeyWindowExpiresAt": {
"format": "date-time",
"type": "string"
},
"failureReason": {
"nullable": true,
"type": "string"
},
"id": {
"format": "uuid",
"type": "string"
},
"introducedGeneration": {
"nullable": true,
"type": "string"
},
"lastCheckpointAt": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"newGenerationEnvelopeHeld": {
"type": "boolean"
},
"oldGenerationItemCount": {
"format": "int32",
"nullable": true,
"type": "integer"
},
"progressPercentage": {
"format": "double",
"type": "number"
},
"revokedPasskeyCount": {
"format": "int32",
"nullable": true,
"type": "integer"
},
"rotatedItems": {
"format": "int32",
"type": "integer"
},
"startedAt": {
"format": "date-time",
"type": "string"
},
"status": {
"nullable": true,
"type": "string"
},
"totalItems": {
"format": "int32",
"type": "integer"
},
"trigger": {
"nullable": true,
"type": "string"
},
"userId": {
"format": "uuid",
"type": "string"
}
},
"type": "object"
},
"ListPasskeyUnlockersResponse": {
"additionalProperties": false,
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/PasskeyUnlockerDto"
},
"nullable": true,
"type": "array"
}
},
"type": "object"
},
"MergeRewrapTaskResponse": {
"additionalProperties": false,
"properties": {
"cancellationReason": {
"nullable": true,
"type": "string"
},
"caseReference": {
"nullable": true,
"type": "string"
},
"checkpointData": {
"nullable": true,
"type": "string"
},
"claimedByDeviceId": {
"nullable": true,
"type": "string"
},
"completedAt": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"expiresAt": {
"format": "date-time",
"type": "string"
},
"handoverAlgorithm": {
"nullable": true,
"type": "string"
},
"handoverEnvelope": {
"nullable": true,
"type": "string"
},
"handoverPosted": {
"type": "boolean"
},
"leaseExpiresAt": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"mergeSessionId": {
"format": "uuid",
"type": "string"
},
"remainingItems": {
"format": "int32",
"type": "integer"
},
"retiringUserId": {
"format": "uuid",
"type": "string"
},
"rewrappedItems": {
"format": "int32",
"type": "integer"
},
"status": {
"nullable": true,
"type": "string"
},
"survivingUserId": {
"format": "uuid",
"type": "string"
},
"survivorKeyRef": {
"nullable": true,
"type": "string"
},
"taskId": {
"format": "uuid",
"type": "string"
},
"totalItems": {
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"NotifyDevicesRequest": {
"additionalProperties": false,
"properties": {
"perDeviceWrappedKeyMaterial": {
"additionalProperties": {
"type": "string"
},
"nullable": true,
"type": "object"
}
},
"type": "object"
},
"NotifyDevicesResponse": {
"additionalProperties": false,
"properties": {
"devicesNotified": {
"format": "int32",
"type": "integer"
},
"notifiedDeviceIds": {
"items": {
"format": "uuid",
"type": "string"
},
"nullable": true,
"type": "array"
},
"skippedDeviceFingerprints": {
"items": {
"type": "string"
},
"nullable": true,
"type": "array"
},
"unmatchedDeviceFingerprints": {
"items": {
"type": "string"
},
"nullable": true,
"type": "array"
}
},
"type": "object"
},
"OpenDeviceIntegrityStepUpRequest": {
"additionalProperties": false,
"properties": {
"bodyDigest": {
"nullable": true,
"type": "string"
},
"method": {
"nullable": true,
"type": "string"
},
"path": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"OpenMergeRewrapTaskRequest": {
"additionalProperties": false,
"properties": {
"caseReference": {
"nullable": true,
"type": "string"
},
"mergeSessionId": {
"format": "uuid",
"type": "string"
},
"retiringUserId": {
"format": "uuid",
"type": "string"
},
"survivingUserId": {
"format": "uuid",
"type": "string"
},
"totalItems": {
"format": "int32",
"type": "integer"
},
"workWindowDays": {
"format": "int32",
"nullable": true,
"type": "integer"
}
},
"type": "object"
},
"PairingSessionResponse": {
"additionalProperties": false,
"properties": {
"completedAt": {
"example": "2025-10-14T15:12:30.0000000+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"createdAt": {
"example": "2025-10-14T15:10:00.0000000+00:00",
"format": "date-time",
"type": "string"
},
"deviceAId": {
"example": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
"format": "uuid",
"type": "string"
},
"deviceBId": {
"example": "f6e5d4c3-b2a1-4f5e-8d9c-1a0b9c8d7e6f",
"format": "uuid",
"nullable": true,
"type": "string"
},
"deviceBPublicKey": {
"example": "{\"kty\":\"RSA\",\"n\":\"xGOvx8i9Z2Pt1KYz...\",\"e\":\"AQAB\",\"alg\":\"RSA-OAEP-256\"}",
"nullable": true,
"type": "string"
},
"expiresAt": {
"example": "2025-10-14T15:15:00.0000000+00:00",
"format": "date-time",
"type": "string"
},
"isExpired": {
"example": false,
"readOnly": true,
"type": "boolean"
},
"joinedAt": {
"example": "2025-10-14T15:11:10.0000000+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"joinerFriendlyName": {
"example": "Pixel 8",
"nullable": true,
"type": "string"
},
"joinerProvenance": {
"example": "Manchester, UK · same network",
"nullable": true,
"type": "string"
},
"joinerSigningKeyApprovedAt": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"joinerSigningKeyThumbprint": {
"nullable": true,
"type": "string"
},
"pairingSessionId": {
"example": "550e8400-e29b-41d4-a716-446655440000",
"format": "uuid",
"type": "string"
},
"status": {
"example": "Completed",
"nullable": true,
"type": "string"
},
"timeRemaining": {
"example": "00:02:30",
"format": "date-span",
"nullable": true,
"readOnly": true,
"type": "string"
},
"wrappedMasterKey": {
"example": "9f0e1d2c3b4a5968e7d6c5b4a39281706f5e4d3c2b1a0988776655443322110fedcba9876543210",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"PasskeyUnlockerDeviceDto": {
"additionalProperties": false,
"properties": {
"deviceName": {
"nullable": true,
"type": "string"
},
"isActive": {
"type": "boolean"
},
"registrationId": {
"format": "uuid",
"type": "string"
}
},
"type": "object"
},
"PasskeyUnlockerDto": {
"additionalProperties": false,
"properties": {
"credentialId": {
"nullable": true,
"type": "string"
},
"enrolledAt": {
"format": "date-time",
"type": "string"
},
"enrolledByDevice": {
"$ref": "#/components/schemas/PasskeyUnlockerDeviceDto"
},
"isPrimary": {
"type": "boolean"
}
},
"type": "object"
},
"PasswordChangeSagaStatusResponse": {
"additionalProperties": false,
"properties": {
"isOpen": {
"type": "boolean"
},
"retryAfterSeconds": {
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"PendingKeyRotationResponse": {
"additionalProperties": false,
"properties": {
"queuedAt": {
"format": "date-time",
"type": "string"
},
"rotationSessionId": {
"format": "uuid",
"type": "string"
},
"wrappedKeyMaterial": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"PendingMergeRewrapTasksResponse": {
"additionalProperties": false,
"properties": {
"tasks": {
"items": {
"$ref": "#/components/schemas/MergeRewrapTaskResponse"
},
"nullable": true,
"type": "array"
}
},
"type": "object"
},
"PendingRotationEnvelopeDto": {
"additionalProperties": false,
"properties": {
"envelope": {
"$ref": "#/components/schemas/WrappedUmkEnvelopeDto"
},
"keyGeneration": {
"nullable": true,
"type": "string"
},
"passkeyEnvelopes": {
"items": {
"$ref": "#/components/schemas/WrappedUmkEnvelopeDto"
},
"nullable": true,
"type": "array"
},
"rotationSessionId": {
"format": "uuid",
"type": "string"
}
},
"type": "object"
},
"PostMergeHandoverRequest": {
"additionalProperties": false,
"properties": {
"algorithm": {
"nullable": true,
"type": "string"
},
"handoverEnvelope": {
"nullable": true,
"type": "string"
},
"survivorKeyRef": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"PostRewrappedEscrowShareRequest": {
"additionalProperties": false,
"properties": {
"holderId": {
"nullable": true,
"type": "string"
},
"rewrapCiphertextBase64": {
"nullable": true,
"type": "string"
},
"shareIndex": {
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"ProblemDetails": {
"additionalProperties": {},
"properties": {
"detail": {
"nullable": true,
"type": "string"
},
"instance": {
"nullable": true,
"type": "string"
},
"status": {
"format": "int32",
"nullable": true,
"type": "integer"
},
"title": {
"nullable": true,
"type": "string"
},
"type": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"ProtectionStatusResponse": {
"additionalProperties": false,
"properties": {
"alternatePassphraseChangedAt": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"alternatePassphraseProvisioned": {
"type": "boolean"
},
"backupVaultChangedAt": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"backupVaultLastReviewedAt": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"backupVaultPresent": {
"type": "boolean"
},
"behaviourAcknowledgedAt": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"behaviourAcknowledgementVersion": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"ProvisionRegistrationEnvelopeRequest": {
"additionalProperties": false,
"properties": {
"authTag": {
"nullable": true,
"type": "string"
},
"iv": {
"nullable": true,
"type": "string"
},
"kdf": {
"$ref": "#/components/schemas/KdfParametersRequest"
},
"wrappedUmk": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"ProvisionRegistrationEnvelopeResponse": {
"additionalProperties": false,
"properties": {
"requestedAt": {
"format": "date-time",
"type": "string"
},
"sagaId": {
"format": "uuid",
"type": "string"
},
"status": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"RebindAfterBiometricMismatchRequest": {
"additionalProperties": false,
"properties": {
"assuranceRef": {
"nullable": true,
"type": "string"
},
"authTag": {
"nullable": true,
"type": "string"
},
"deviceId": {
"nullable": true,
"type": "string"
},
"deviceName": {
"nullable": true,
"type": "string"
},
"deviceType": {
"nullable": true,
"type": "string"
},
"iv": {
"nullable": true,
"type": "string"
},
"kdf": {
"$ref": "#/components/schemas/KdfParametersRequest"
},
"publicKey": {
"nullable": true,
"type": "string"
},
"revokePreviousDevice": {
"type": "boolean"
},
"wrappedUmk": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"RecordBreakGlassConsentRequest": {
"additionalProperties": false,
"properties": {
"granteeId": {
"format": "uuid",
"type": "string"
},
"granteeLabel": {
"nullable": true,
"type": "string"
},
"granteeType": {
"nullable": true,
"type": "string"
},
"holderLabel": {
"nullable": true,
"type": "string"
},
"legalBasis": {
"nullable": true,
"type": "string"
},
"purpose": {
"nullable": true,
"type": "string"
},
"scopeCategories": {
"items": {
"type": "string"
},
"nullable": true,
"type": "array"
},
"tenantId": {
"format": "uuid",
"nullable": true,
"type": "string"
},
"windowEnd": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"windowStart": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"RecordEmergencyCardReadRequest": {
"additionalProperties": false,
"properties": {
"channel": {
"nullable": true,
"type": "string"
},
"disclosureLevel": {
"nullable": true,
"type": "string"
},
"instanceId": {
"format": "uuid",
"type": "string"
},
"nominatedContactUserIds": {
"items": {
"format": "uuid",
"type": "string"
},
"nullable": true,
"type": "array"
},
"occurredAt": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"responderType": {
"nullable": true,
"type": "string"
},
"subjectUserId": {
"format": "uuid",
"type": "string"
}
},
"type": "object"
},
"RecoveryRewrapRequest": {
"additionalProperties": false,
"properties": {
"authHashUpdate": {
"$ref": "#/components/schemas/AuthHashUpdateRequest"
},
"authTag": {
"nullable": true,
"type": "string"
},
"iv": {
"nullable": true,
"type": "string"
},
"kdf": {
"$ref": "#/components/schemas/KdfParametersRequest"
},
"wrappedUmk": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"RecoveryRewrapResponse": {
"additionalProperties": false,
"properties": {
"recoveryEnrolmentTicket": {
"nullable": true,
"type": "string"
},
"requestedAt": {
"format": "date-time",
"type": "string"
},
"sagaId": {
"format": "uuid",
"type": "string"
},
"status": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"RecoverySessionResponse": {
"additionalProperties": false,
"properties": {
"absoluteExpiresAt": {
"format": "date-time",
"type": "string"
},
"canExtend": {
"type": "boolean"
},
"configId": {
"format": "uuid",
"nullable": true,
"type": "string"
},
"effectiveDeadline": {
"format": "date-time",
"type": "string"
},
"expiresAt": {
"format": "date-time",
"type": "string"
},
"extensionCount": {
"format": "int32",
"type": "integer"
},
"extensionsRemaining": {
"format": "int32",
"type": "integer"
},
"id": {
"format": "uuid",
"type": "string"
},
"initiatedAt": {
"format": "date-time",
"type": "string"
},
"status": {
"nullable": true,
"type": "string"
},
"userId": {
"format": "uuid",
"type": "string"
}
},
"type": "object"
},
"RegisterDeviceRequest": {
"additionalProperties": false,
"properties": {
"deviceFingerprint": {
"nullable": true,
"type": "string"
},
"deviceName": {
"nullable": true,
"type": "string"
},
"deviceType": {
"nullable": true,
"type": "string"
},
"publicKey": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"RehearsalGateResultDto": {
"additionalProperties": false,
"properties": {
"detail": {
"nullable": true,
"type": "string"
},
"gate": {
"nullable": true,
"type": "string"
},
"passed": {
"type": "boolean"
}
},
"type": "object"
},
"RekeyMajorityTransitionRequest": {
"additionalProperties": false,
"properties": {
"authTag": {
"nullable": true,
"type": "string"
},
"iv": {
"nullable": true,
"type": "string"
},
"kdf": {
"$ref": "#/components/schemas/KdfParametersRequest"
},
"transitionId": {
"format": "uuid",
"type": "string"
},
"wrappedUmk": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"RekeyMajorityTransitionResponse": {
"additionalProperties": false,
"properties": {
"keyGeneration": {
"nullable": true,
"type": "string"
},
"rekeyedAt": {
"format": "date-time",
"type": "string"
},
"transitionId": {
"format": "uuid",
"type": "string"
},
"version": {
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"ReleaseExecutorBequestRequest": {
"additionalProperties": false,
"properties": {
"bequestId": {
"format": "uuid",
"type": "string"
},
"estateGrantId": {
"format": "uuid",
"type": "string"
}
},
"type": "object"
},
"ReleaseExecutorBequestResponse": {
"additionalProperties": false,
"properties": {
"availableItemCount": {
"format": "int32",
"type": "integer"
},
"bequestId": {
"format": "uuid",
"type": "string"
},
"releasedAt": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"status": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"ReleaseMergeRewrapRequest": {
"additionalProperties": false,
"properties": {
"deviceId": {
"nullable": true,
"type": "string"
},
"reason": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"RequestEscrowReconstructionRequest": {
"additionalProperties": false,
"properties": {
"enrolmentId": {
"nullable": true,
"type": "string"
},
"justification": {
"nullable": true,
"type": "string"
},
"requesterPublicKeyJwk": {
"nullable": true,
"type": "string"
},
"requestingOrgId": {
"format": "uuid",
"type": "string"
},
"resolveHereOnly": {
"type": "boolean"
},
"subjectUserId": {
"format": "uuid",
"nullable": true,
"type": "string"
},
"vaultCategory": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"RespondToPairingRequest": {
"additionalProperties": false,
"properties": {
"challengeSolution": {
"example": "8a9b0c1d2e3f4a5b6c7d8e9f0a1b2c3d4e5f6a7b8c9d0e1f",
"nullable": true,
"type": "string"
},
"deviceBId": {
"example": "f6e5d4c3-b2a1-4f5e-8d9c-1a0b9c8d7e6f",
"format": "uuid",
"type": "string"
},
"deviceBPublicKey": {
"example": "{\"kty\":\"RSA\",\"n\":\"xGOvx8i9Z2Pt1KYz...\",\"e\":\"AQAB\",\"alg\":\"RSA-OAEP-256\",\"key_ops\":[\"encrypt\"]}",
"nullable": true,
"type": "string"
},
"deviceBSigningKeyJwk": {
"nullable": true,
"type": "string"
},
"deviceFriendlyName": {
"example": "Pixel 8",
"nullable": true,
"type": "string"
},
"deviceProvenance": {
"example": "Manchester, UK · same network",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"ResponderHolderListResponse": {
"additionalProperties": false,
"properties": {
"holders": {
"items": {
"$ref": "#/components/schemas/ResponderHolderResponse"
},
"nullable": true,
"type": "array"
},
"nextCursor": {
"format": "date-time",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"ResponderHolderResponse": {
"additionalProperties": false,
"properties": {
"createdAt": {
"format": "date-time",
"type": "string"
},
"credentialedClasses": {
"items": {
"type": "string"
},
"nullable": true,
"type": "array"
},
"credentialedResponders": {
"items": {
"$ref": "#/components/schemas/CredentialedResponderSummary"
},
"nullable": true,
"type": "array"
},
"enrolmentAdminId": {
"format": "uuid",
"type": "string"
},
"holderId": {
"nullable": true,
"type": "string"
},
"holderRole": {
"nullable": true,
"type": "string"
},
"organisationId": {
"format": "uuid",
"type": "string"
},
"revokedAt": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"status": {
"nullable": true,
"type": "string"
},
"tenantId": {
"format": "uuid",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"RevealAllBequeathedCredentialsResponse": {
"additionalProperties": false,
"properties": {
"bequestId": {
"format": "uuid",
"type": "string"
},
"items": {
"items": {
"$ref": "#/components/schemas/RevealedBequeathedCredentialResponse"
},
"nullable": true,
"type": "array"
}
},
"type": "object"
},
"RevealedBequeathedCredentialResponse": {
"additionalProperties": false,
"properties": {
"authTag": {
"nullable": true,
"type": "string"
},
"executorKeyRef": {
"nullable": true,
"type": "string"
},
"itemId": {
"nullable": true,
"type": "string"
},
"itemName": {
"nullable": true,
"type": "string"
},
"iv": {
"nullable": true,
"type": "string"
},
"revealCount": {
"format": "int32",
"type": "integer"
},
"revealedAt": {
"format": "date-time",
"type": "string"
},
"sealedSecret": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"RevokeEmergencyAccessBySignedLinkRequest": {
"additionalProperties": false,
"properties": {
"expiresAtUnix": {
"format": "int64",
"type": "integer"
},
"sessionId": {
"format": "uuid",
"type": "string"
},
"signature": {
"nullable": true,
"type": "string"
},
"userId": {
"format": "uuid",
"type": "string"
}
},
"type": "object"
},
"RevokeEmergencyAccessBySignedLinkResponse": {
"additionalProperties": false,
"properties": {
"alreadyEnded": {
"type": "boolean"
},
"endedAs": {
"nullable": true,
"type": "string"
},
"endedAt": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"revoked": {
"type": "boolean"
}
},
"type": "object"
},
"RevokeEscrowEnrolmentRequest": {
"additionalProperties": false,
"properties": {
"reason": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"RevokeSharedCredentialWrapRequest": {
"additionalProperties": false,
"properties": {
"householdId": {
"format": "uuid",
"type": "string"
},
"sharedCredentialId": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"RevokeWipeAttestationRequest": {
"additionalProperties": false,
"properties": {
"reason": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"RewrapSharedCredentialRequest": {
"additionalProperties": false,
"properties": {
"householdId": {
"format": "uuid",
"type": "string"
},
"recipients": {
"items": {
"$ref": "#/components/schemas/SharedCredentialRecipientWrapDto"
},
"nullable": true,
"type": "array"
},
"sharedCredentialId": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"RewrapSharedCredentialResponse": {
"additionalProperties": false,
"properties": {
"generation": {
"format": "int32",
"type": "integer"
},
"recipientCount": {
"format": "int32",
"type": "integer"
},
"updatedAt": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"RewrapWrappedUmkEnvelopeRequest": {
"additionalProperties": false,
"properties": {
"authTag": {
"nullable": true,
"type": "string"
},
"iv": {
"nullable": true,
"type": "string"
},
"kdf": {
"$ref": "#/components/schemas/KdfParametersRequest"
},
"postRecoveryBypass": {
"type": "boolean"
},
"wrappedUmk": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"RewrapWrappedUmkEnvelopeResponse": {
"additionalProperties": false,
"properties": {
"updatedAt": {
"format": "date-time",
"type": "string"
},
"version": {
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"RotateApproverPinRequest": {
"additionalProperties": false,
"properties": {
"attestation": {
"nullable": true,
"type": "string"
},
"credentialPin": {
"nullable": true,
"type": "string"
},
"tenantId": {
"format": "uuid",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"RotateDeviceKeyExchangeKeyRequest": {
"additionalProperties": false,
"properties": {
"publicKey": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"RotationEnvelopeRequest": {
"additionalProperties": false,
"properties": {
"authTag": {
"nullable": true,
"type": "string"
},
"iv": {
"nullable": true,
"type": "string"
},
"kdf": {
"$ref": "#/components/schemas/KdfParametersRequest"
},
"wrappedUmk": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"RotationPasskeyRewrapRequest": {
"additionalProperties": false,
"properties": {
"authTag": {
"nullable": true,
"type": "string"
},
"iv": {
"nullable": true,
"type": "string"
},
"passkeyCredentialId": {
"nullable": true,
"type": "string"
},
"prfInput": {
"nullable": true,
"type": "string"
},
"wrappedUmk": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"SealExecutorBequestRequest": {
"additionalProperties": false,
"properties": {
"estateGrantId": {
"format": "uuid",
"type": "string"
},
"executorUserId": {
"format": "uuid",
"type": "string"
},
"items": {
"items": {
"$ref": "#/components/schemas/BequeathedCredentialItemDto"
},
"nullable": true,
"type": "array"
},
"triggerLabel": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"SealExecutorBequestResponse": {
"additionalProperties": false,
"properties": {
"bequestId": {
"format": "uuid",
"type": "string"
},
"createdAt": {
"format": "date-time",
"type": "string"
},
"executorUserId": {
"format": "uuid",
"type": "string"
},
"itemCount": {
"format": "int32",
"type": "integer"
},
"status": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"SecureWipeDeviceRequest": {
"additionalProperties": false,
"properties": {
"attesterClass": {
"nullable": true,
"type": "string"
},
"attesterLabel": {
"nullable": true,
"type": "string"
},
"confirmationAcknowledged": {
"type": "boolean"
},
"signatureAlgorithm": {
"nullable": true,
"type": "string"
},
"signatureThumbprint": {
"nullable": true,
"type": "string"
},
"wipeStandardClaimed": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"SetAlternatePassphraseStatusRequest": {
"additionalProperties": false,
"properties": {
"behaviourAcknowledgementVersion": {
"nullable": true,
"type": "string"
},
"provisioned": {
"type": "boolean"
}
},
"type": "object"
},
"SetBackupVaultStatusRequest": {
"additionalProperties": false,
"properties": {
"lastReviewedAt": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"present": {
"type": "boolean"
}
},
"type": "object"
},
"SetBreakGlassConsentHolderLabelRequest": {
"additionalProperties": false,
"properties": {
"holderLabel": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"SharedCredentialRecipientWrapDto": {
"additionalProperties": false,
"properties": {
"authTag": {
"nullable": true,
"type": "string"
},
"iv": {
"nullable": true,
"type": "string"
},
"recipientKeyRef": {
"nullable": true,
"type": "string"
},
"recipientUserId": {
"format": "uuid",
"type": "string"
},
"wrappedSecret": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"SharedCredentialWrapForRecipientResponse": {
"additionalProperties": false,
"properties": {
"authTag": {
"nullable": true,
"type": "string"
},
"generation": {
"format": "int32",
"type": "integer"
},
"iv": {
"nullable": true,
"type": "string"
},
"recipientKeyRef": {
"nullable": true,
"type": "string"
},
"sharedCredentialId": {
"nullable": true,
"type": "string"
},
"wrappedSecret": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"SignalUnlockResolutionRequest": {
"additionalProperties": false,
"properties": {
"duressChannel": {
"nullable": true,
"type": "string"
},
"kind": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"SignalUnlockResolutionResponse": {
"additionalProperties": false,
"properties": {
"status": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"SubmitDeviceIntegrityAssertionRequest": {
"additionalProperties": false,
"properties": {
"assertionObject": {
"nullable": true,
"type": "string"
},
"keyId": {
"nullable": true,
"type": "string"
},
"nonce": {
"nullable": true,
"type": "string"
},
"platform": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"SubmitDeviceIntegrityAttestationRequest": {
"additionalProperties": false,
"properties": {
"attestationObject": {
"nullable": true,
"type": "string"
},
"integrityToken": {
"nullable": true,
"type": "string"
},
"keyId": {
"nullable": true,
"type": "string"
},
"nonce": {
"nullable": true,
"type": "string"
},
"platform": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"UpdateBreakGlassConsentScopeRequest": {
"additionalProperties": false,
"properties": {
"scopeCategories": {
"items": {
"type": "string"
},
"nullable": true,
"type": "array"
}
},
"type": "object"
},
"UpsertUserPrivateKeyEnvelopeRequest": {
"additionalProperties": false,
"properties": {
"algo": {
"nullable": true,
"type": "string"
},
"ciphertext": {
"nullable": true,
"type": "string"
},
"iv": {
"nullable": true,
"type": "string"
},
"keyEpoch": {
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"UserPrivateKeyEnvelopeResponse": {
"additionalProperties": false,
"properties": {
"algo": {
"nullable": true,
"type": "string"
},
"ciphertext": {
"nullable": true,
"type": "string"
},
"iv": {
"nullable": true,
"type": "string"
},
"keyEpoch": {
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"VerifyBiometricMismatchFallbackRequest": {
"additionalProperties": false,
"properties": {
"recoveryCode": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"WipeAttestationResponse": {
"additionalProperties": false,
"properties": {
"algorithm": {
"nullable": true,
"type": "string"
},
"attestationDigest": {
"nullable": true,
"type": "string"
},
"attestationId": {
"format": "uuid",
"type": "string"
},
"attesterClass": {
"nullable": true,
"type": "string"
},
"attesterLabel": {
"nullable": true,
"type": "string"
},
"deviceId": {
"format": "uuid",
"type": "string"
},
"deviceIdentifier": {
"nullable": true,
"type": "string"
},
"deviceName": {
"nullable": true,
"type": "string"
},
"isRevoked": {
"type": "boolean"
},
"revocationReason": {
"nullable": true,
"type": "string"
},
"revokedAt": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"signatureAlgorithm": {
"nullable": true,
"type": "string"
},
"signatureThumbprint": {
"nullable": true,
"type": "string"
},
"statement": {
"nullable": true,
"type": "string"
},
"wipeStandardClaimed": {
"nullable": true,
"type": "string"
},
"wipedAt": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"WrapSharedCredentialRequest": {
"additionalProperties": false,
"properties": {
"householdId": {
"format": "uuid",
"type": "string"
},
"recipients": {
"items": {
"$ref": "#/components/schemas/SharedCredentialRecipientWrapDto"
},
"nullable": true,
"type": "array"
},
"sharedCredentialId": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"WrapSharedCredentialResponse": {
"additionalProperties": false,
"properties": {
"createdAt": {
"format": "date-time",
"type": "string"
},
"generation": {
"format": "int32",
"type": "integer"
},
"recipientCount": {
"format": "int32",
"type": "integer"
},
"wrapId": {
"format": "uuid",
"type": "string"
}
},
"type": "object"
},
"WrappedUmkEnvelopeDto": {
"additionalProperties": false,
"properties": {
"authTag": {
"nullable": true,
"type": "string"
},
"iv": {
"nullable": true,
"type": "string"
},
"kdf": {
"$ref": "#/components/schemas/KdfParametersDto"
},
"keyGeneration": {
"nullable": true,
"type": "string"
},
"kind": {
"nullable": true,
"type": "string"
},
"manifestAuthTag": {
"nullable": true,
"type": "string"
},
"manifestIv": {
"nullable": true,
"type": "string"
},
"passkeyCredentialId": {
"nullable": true,
"type": "string"
},
"sealedManifest": {
"nullable": true,
"type": "string"
},
"wrappedUmk": {
"nullable": true,
"type": "string"
}
},
"type": "object"
}
},
"securitySchemes": {
"Bearer": {
"bearerFormat": "JWT",
"description": "JWT Authorization header using the Bearer scheme.",
"scheme": "bearer",
"type": "http"
}
}
},
"info": {
"contact": {
"email": "support@essence.local",
"name": "Essence Platform Team",
"url": "https://essence.local/support"
},
"description": "API for secure multi-device key synchronization using QR pairing, Shamir recovery, and enterprise escrow.\n\nAll endpoints require a Bearer token (SEC-001).",
"title": "Multi-Device Sync API",
"version": "v1.0"
},
"openapi": "3.0.1",
"paths": {
"/api/v1/devices": {
"get": {
"operationId": "Devices_ListDevices",
"parameters": [
{
"description": "Optional cursor for pagination.",
"in": "query",
"name": "cursor",
"schema": {
"type": "string"
}
},
{
"description": "Page size (default 10, max 50).",
"in": "query",
"name": "limit",
"schema": {
"default": 10,
"format": "int32",
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"hasMore": false,
"items": [],
"nextCursor": "string",
"pageSize": 0,
"previousCursor": "string"
},
"schema": {
"$ref": "#/components/schemas/DeviceRegistrationResponseCursorResult"
}
}
},
"description": "Devices listed successfully"
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Bad Request"
},
"500": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Internal Server Error"
}
},
"summary": "Lists all active devices for the current user with keyset pagination (DAT-006).",
"tags": [
"Devices"
]
},
"post": {
"description": "A repeat registration of a fingerprint already active for the user is not an error and\r\nnot a second device: it refreshes the existing registration and answers `200 OK`\r\nwith it. Only a registration that actually admitted a new device answers\r\n`201 Created`, and only that branch can be refused by the FR-01.007 cap (#7271 —\r\npreviously every call inserted a row, so a client registering on each load exhausted\r\nthe cap and was then refused forever).",
"operationId": "Devices_RegisterDevice",
"requestBody": {
"content": {
"application/*+json": {
"example": {
"deviceFingerprint": "string",
"deviceName": "string",
"deviceType": "string",
"publicKey": "string"
},
"schema": {
"$ref": "#/components/schemas/RegisterDeviceRequest"
}
},
"application/json": {
"example": {
"deviceFingerprint": "string",
"deviceName": "string",
"deviceType": "string",
"publicKey": "string"
},
"schema": {
"$ref": "#/components/schemas/RegisterDeviceRequest"
}
},
"text/json": {
"example": {
"deviceFingerprint": "string",
"deviceName": "string",
"deviceType": "string",
"publicKey": "string"
},
"schema": {
"$ref": "#/components/schemas/RegisterDeviceRequest"
}
}
},
"description": "Register device request"
},
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"deviceId": "string",
"deviceName": "string",
"deviceType": "string",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"isActive": false,
"lastSeenAt": "2026-01-01T00:00:00.0000000+00:00",
"publicKey": "string",
"registeredAt": "2026-01-01T00:00:00.0000000+00:00",
"signingKeyEnrolledAt": "2026-01-01T00:00:00.0000000+00:00",
"signingKeyEnrolmentMethod": "string",
"signingKeyThumbprint": "string",
"suspectedLostAt": "2026-01-01T00:00:00.0000000+00:00",
"suspectedLostRecoverySessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"schema": {
"$ref": "#/components/schemas/DeviceRegistrationResponse"
}
}
},
"description": "This fingerprint was already registered; the existing registration was refreshed and returned"
},
"201": {
"content": {
"application/json": {
"example": {
"deviceId": "string",
"deviceName": "string",
"deviceType": "string",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"isActive": false,
"lastSeenAt": "2026-01-01T00:00:00.0000000+00:00",
"publicKey": "string",
"registeredAt": "2026-01-01T00:00:00.0000000+00:00",
"signingKeyEnrolledAt": "2026-01-01T00:00:00.0000000+00:00",
"signingKeyEnrolmentMethod": "string",
"signingKeyThumbprint": "string",
"suspectedLostAt": "2026-01-01T00:00:00.0000000+00:00",
"suspectedLostRecoverySessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"schema": {
"$ref": "#/components/schemas/DeviceRegistrationResponse"
}
}
},
"description": "Device registered successfully"
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Bad Request"
},
"409": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Device limit exceeded (FR-01.007), or — with `reason``device_key_exchange_key_change_requires_proof` — a repeat registration tried to change the\r\n key of a device with an enrolled signing key, which only the proved rotation may do (#18640)"
},
"500": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Internal Server Error"
}
},
"summary": "Registers this device for the authenticated user. Idempotent per device fingerprint.",
"tags": [
"Devices"
]
}
},
"/api/v1/devices/wipe-attestations/{attestationId}": {
"get": {
"operationId": "Devices_GetWipeAttestation",
"parameters": [
{
"description": "Wipe attestation ID.",
"in": "path",
"name": "attestationId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"algorithm": "string",
"attestationDigest": "string",
"attestationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"attesterClass": "string",
"attesterLabel": "string",
"deviceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"deviceIdentifier": "string",
"deviceName": "string",
"isRevoked": false,
"revocationReason": "string",
"revokedAt": "2026-01-01T00:00:00.0000000+00:00",
"signatureAlgorithm": "string",
"signatureThumbprint": "string",
"statement": "string",
"wipeStandardClaimed": "string",
"wipedAt": "2026-01-01T00:00:00.0000000+00:00"
},
"schema": {
"$ref": "#/components/schemas/WipeAttestationResponse"
}
}
},
"description": "Attestation returned."
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Bad Request"
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Attestation not found or not owned by caller."
}
},
"summary": "Reads / exports a resale wipe attestation certificate (FR-01.060-distinct,\r\ndebt-2026-07-07-033, journey `device-trade-in-secure-wipe-attestation-to-resale`).\r\nThe holder retrieves the signed certificate — and its live/revoked state — to present to\r\na resale counterparty. Ownership-scoped: a non-owner sees 404 (no existence oracle).",
"tags": [
"Devices"
]
}
},
"/api/v1/devices/wipe-attestations/{attestationId}/revoke": {
"post": {
"operationId": "Devices_RevokeWipeAttestation",
"parameters": [
{
"description": "Wipe attestation ID.",
"in": "path",
"name": "attestationId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/*+json": {
"example": {
"reason": "string"
},
"schema": {
"$ref": "#/components/schemas/RevokeWipeAttestationRequest"
}
},
"application/json": {
"example": {
"reason": "string"
},
"schema": {
"$ref": "#/components/schemas/RevokeWipeAttestationRequest"
}
},
"text/json": {
"example": {
"reason": "string"
},
"schema": {
"$ref": "#/components/schemas/RevokeWipeAttestationRequest"
}
}
},
"description": "Revocation request carrying the reason."
},
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"algorithm": "string",
"attestationDigest": "string",
"attestationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"attesterClass": "string",
"attesterLabel": "string",
"deviceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"deviceIdentifier": "string",
"deviceName": "string",
"isRevoked": false,
"revocationReason": "string",
"revokedAt": "2026-01-01T00:00:00.0000000+00:00",
"signatureAlgorithm": "string",
"signatureThumbprint": "string",
"statement": "string",
"wipeStandardClaimed": "string",
"wipedAt": "2026-01-01T00:00:00.0000000+00:00"
},
"schema": {
"$ref": "#/components/schemas/WipeAttestationResponse"
}
}
},
"description": "Attestation revoked; the revoked certificate is returned."
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Missing revocation reason or invalid request."
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Attestation not found or not owned by caller."
},
"409": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Attestation already revoked."
}
},
"summary": "Revokes a resale wipe attestation certificate (FR-01.060-distinct, debt-2026-07-07-033).\r\nMarks the certificate so a counterparty checking it sees it is no longer live — e.g. it\r\nwas issued in error or the device was not actually wiped. Ownership-scoped (404 for a\r\nnon-owner); a second revoke is rejected with 409.",
"tags": [
"Devices"
]
}
},
"/api/v1/devices/{id}": {
"delete": {
"operationId": "Devices_RemoveDevice",
"parameters": [
{
"description": "Device registration ID",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"description": "FR-01.049 deferred-rotation (\"Lock out later\") choice (debt-2026-06-18-331). When\r\n`false` (the secure default) the UMK is rotated immediately so the removed device\r\nloses access at once. When `true` the user has made the informed choice to defer\r\nrotation; the residual-access threat is recorded and audit-anchored\r\n(`DeviceRemovedEvent.RekeyAction == \"deferred-warned\"`) rather than rotating now.",
"in": "query",
"name": "deferRotation",
"schema": {
"default": false,
"type": "boolean"
}
},
{
"description": "Why the owner is removing the device (FR-01.049, #18043): `user-initiated`,\r\n`lost` or `stolen` (`DeviceRemovalReasons.OwnerDeclarable`). Omitted means\r\nan ordinary removal. Carried onto `DeviceRemovedEvent.Reason`, so a theft reported\r\nhere is anchored the same way as one reported on Auth's `DELETE /api/v1/devices/{id}`.",
"in": "query",
"name": "reason",
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Device removed successfully"
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "The reason is not one an owner may state."
},
"401": {
"description": "No acceptable step-up elevation was presented (#8641)."
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Device not found"
},
"500": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Internal Server Error"
}
},
"summary": "Removes (unpairs) a device via the single authoritative FR-01.049 removal path.",
"tags": [
"Devices"
]
},
"get": {
"operationId": "Devices_GetDevice",
"parameters": [
{
"description": "Device registration ID",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"deviceId": "string",
"deviceName": "string",
"deviceType": "string",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"isActive": false,
"lastSeenAt": "2026-01-01T00:00:00.0000000+00:00",
"publicKey": "string",
"registeredAt": "2026-01-01T00:00:00.0000000+00:00",
"signingKeyEnrolledAt": "2026-01-01T00:00:00.0000000+00:00",
"signingKeyEnrolmentMethod": "string",
"signingKeyThumbprint": "string",
"suspectedLostAt": "2026-01-01T00:00:00.0000000+00:00",
"suspectedLostRecoverySessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"schema": {
"$ref": "#/components/schemas/DeviceRegistrationResponse"
}
}
},
"description": "Device found"
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Device not found"
},
"500": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Internal Server Error"
}
},
"summary": "Gets a specific device registration.",
"tags": [
"Devices"
]
}
},
"/api/v1/devices/{id}/challenges": {
"post": {
"description": "`Proof` challenges are what an `X-Device-Proof` on a key-custody request signs;\r\n they are only issued to the device whose enrolled signing key is bound to this token.\r\n `Enrolment` challenges are what a device signs with the key it is enrolling.",
"operationId": "Devices_IssueChallenge",
"parameters": [
{
"description": "Device registration ID.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/*+json": {
"example": {
"purpose": "string"
},
"schema": {
"$ref": "#/components/schemas/IssueDeviceChallengeRequest"
}
},
"application/json": {
"example": {
"purpose": "string"
},
"schema": {
"$ref": "#/components/schemas/IssueDeviceChallengeRequest"
}
},
"text/json": {
"example": {
"purpose": "string"
},
"schema": {
"$ref": "#/components/schemas/IssueDeviceChallengeRequest"
}
}
},
"description": "The challenge purpose."
},
"responses": {
"201": {
"content": {
"application/json": {
"example": {
"challengeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"deviceRegistrationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"expiresAt": "2026-01-01T00:00:00.0000000+00:00",
"nonce": "string",
"purpose": "string"
},
"schema": {
"$ref": "#/components/schemas/DeviceChallengeResponse"
}
}
},
"description": "Challenge issued."
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Invalid purpose, or the token carries no device_id."
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Device not found or not owned by the caller."
},
"409": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "A proof challenge was asked for a device with no enrolled signing key for this session."
},
"429": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Too Many Requests"
}
},
"summary": "Issues a short-lived, single-use challenge for one of the caller's devices (SEC-009(a)).",
"tags": [
"Devices"
]
}
},
"/api/v1/devices/{id}/confirm-held": {
"post": {
"description": "Must be sent from ANOTHER enrolled device of the account that is not itself flagged, with an\r\nX-Device-Proof verified against that device's enrolled key. The handler requires the verified\r\nproof whatever the rollout mode: a flagged device cannot clear its own flag.",
"operationId": "Devices_ConfirmDeviceHeld",
"parameters": [
{
"description": "The flagged device registration ID.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"deviceId": "string",
"deviceName": "string",
"deviceType": "string",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"isActive": false,
"lastSeenAt": "2026-01-01T00:00:00.0000000+00:00",
"publicKey": "string",
"registeredAt": "2026-01-01T00:00:00.0000000+00:00",
"signingKeyEnrolledAt": "2026-01-01T00:00:00.0000000+00:00",
"signingKeyEnrolmentMethod": "string",
"signingKeyThumbprint": "string",
"suspectedLostAt": "2026-01-01T00:00:00.0000000+00:00",
"suspectedLostRecoverySessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"schema": {
"$ref": "#/components/schemas/DeviceRegistrationResponse"
}
}
},
"description": "The flag is cleared (or was already clear); the registration is returned."
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "No X-Device-Proof verified against an enrolled key of this account."
},
"403": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "The confirming device is the device itself, is flagged, or holds no enrolled key."
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Device not found or not owned by the caller."
}
},
"summary": "\"I still have this device\" (#17684): clears the possibly-lost flag a recovery enrolment on\r\nanother device put on this registration (#17572), so it can approve pairings again.",
"tags": [
"Devices"
]
}
},
"/api/v1/devices/{id}/integrity": {
"get": {
"operationId": "DeviceIntegrity_GetIntegrity",
"parameters": [
{
"description": "Device registration ID.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"appAttestRiskMetric": 0,
"appAttestRiskMetricReadAt": "2026-01-01T00:00:00.0000000+00:00",
"change": "string",
"deviceRegistrationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"observed": false,
"observedAt": "2026-01-01T00:00:00.0000000+00:00",
"platform": "string",
"posture": "string",
"postureReason": "string",
"priorVerdict": "string",
"reason": "string",
"stale": false,
"verdict": "string"
},
"schema": {
"$ref": "#/components/schemas/DeviceIntegrityResponse"
}
}
},
"description": "The latest verdict, or `observed: false`."
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Device not found or not owned by the caller."
}
},
"summary": "This device's latest server-verified integrity verdict (FR-01.104). `observed: false`\r\nwhen it has never been attested — not the same as a failure.",
"tags": [
"DeviceIntegrity"
]
}
},
"/api/v1/devices/{id}/integrity-assertions": {
"post": {
"description": "This is the cheap re-check: Apple rate-limits `attestKey`, so only a device's FIRST check\r\ngoes to `integrity-attestations` and every later one comes here. The device asks\r\n`POST {id}/challenges` for an `Integrity` nonce and calls\r\n`DCAppAttestService.generateAssertion(keyId, clientDataHash)` with\r\n`clientDataHash = SHA-256(UTF-8(nonce))`.\r\nA judged assertion returns 200 whether it passed or failed — including a replay, whose\r\ncounter did not increase: that verifies cryptographically and so is a statement about the device\r\n(`assertion_counter_replayed`), not a request error. Refusals (400/401/403/404/409/503)\r\nrecord nothing.",
"operationId": "DeviceIntegrity_SubmitIntegrityAssertion",
"parameters": [
{
"description": "Device registration ID.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/*+json": {
"example": {
"assertionObject": "string",
"keyId": "string",
"nonce": "string",
"platform": "string"
},
"schema": {
"$ref": "#/components/schemas/SubmitDeviceIntegrityAssertionRequest"
}
},
"application/json": {
"example": {
"assertionObject": "string",
"keyId": "string",
"nonce": "string",
"platform": "string"
},
"schema": {
"$ref": "#/components/schemas/SubmitDeviceIntegrityAssertionRequest"
}
},
"text/json": {
"example": {
"assertionObject": "string",
"keyId": "string",
"nonce": "string",
"platform": "string"
},
"schema": {
"$ref": "#/components/schemas/SubmitDeviceIntegrityAssertionRequest"
}
}
},
"description": "Platform, challenge nonce, the attested App Attest key id and the assertion object."
},
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"appAttestRiskMetric": 0,
"appAttestRiskMetricReadAt": "2026-01-01T00:00:00.0000000+00:00",
"change": "string",
"deviceRegistrationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"observed": false,
"observedAt": "2026-01-01T00:00:00.0000000+00:00",
"platform": "string",
"posture": "string",
"postureReason": "string",
"priorVerdict": "string",
"reason": "string",
"stale": false,
"verdict": "string"
},
"schema": {
"$ref": "#/components/schemas/DeviceIntegrityResponse"
}
}
},
"description": "The assertion was judged; the recorded verdict and its change from the prior are returned."
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Unsupported platform, malformed base64, or the token carries no device_id."
},
"401": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "The nonce is not an unspent, unexpired Integrity challenge issued to this device."
},
"403": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "This device's signing key is bound to another session."
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Device not found or not owned by the caller."
},
"409": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "No attested key is on record under that key id; the device must attest first."
},
"503": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Verification is not configured here; the device was not judged."
}
},
"summary": "Re-checks this device's integrity with an App Attest assertion signed by the key it\r\nalready attested, and records the verdict against its previous one (FR-01.104, #22108).",
"tags": [
"DeviceIntegrity"
]
}
},
"/api/v1/devices/{id}/integrity-attestations": {
"post": {
"description": "A judged attestation returns 200 whether it passed or failed — a failure is a recorded verdict,\r\nnot a request error. Refusals (400/401/403/404/503) record nothing. The two platforms are\r\nconfigured independently, so one can be judgeable here while the other answers 503.",
"operationId": "DeviceIntegrity_SubmitIntegrityAttestation",
"parameters": [
{
"description": "Device registration ID.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/*+json": {
"example": {
"attestationObject": "string",
"integrityToken": "string",
"keyId": "string",
"nonce": "string",
"platform": "string"
},
"schema": {
"$ref": "#/components/schemas/SubmitDeviceIntegrityAttestationRequest"
}
},
"application/json": {
"example": {
"attestationObject": "string",
"integrityToken": "string",
"keyId": "string",
"nonce": "string",
"platform": "string"
},
"schema": {
"$ref": "#/components/schemas/SubmitDeviceIntegrityAttestationRequest"
}
},
"text/json": {
"example": {
"attestationObject": "string",
"integrityToken": "string",
"keyId": "string",
"nonce": "string",
"platform": "string"
},
"schema": {
"$ref": "#/components/schemas/SubmitDeviceIntegrityAttestationRequest"
}
}
},
"description": "Platform, challenge nonce, and that platform's evidence — App Attest key id + attestation object, or a Play Integrity token."
},
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"appAttestRiskMetric": 0,
"appAttestRiskMetricReadAt": "2026-01-01T00:00:00.0000000+00:00",
"change": "string",
"deviceRegistrationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"observed": false,
"observedAt": "2026-01-01T00:00:00.0000000+00:00",
"platform": "string",
"posture": "string",
"postureReason": "string",
"priorVerdict": "string",
"reason": "string",
"stale": false,
"verdict": "string"
},
"schema": {
"$ref": "#/components/schemas/DeviceIntegrityResponse"
}
}
},
"description": "The attestation was judged; the recorded verdict and its change from the prior are returned."
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Unsupported platform, malformed base64, or the token carries no device_id."
},
"401": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "The nonce is not an unspent, unexpired Integrity challenge issued to this device."
},
"403": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "This device's signing key is bound to another session."
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Device not found or not owned by the caller."
},
"503": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Verification is not configured here; the device was not judged."
}
},
"summary": "Verifies a platform integrity attestation for this device and records the verdict against its\r\nprevious one (FR-01.104, #17940). iOS App Attest or Android Play Integrity (#22105);\r\neither way it binds an `Integrity` challenge from `POST {id}/challenges`.",
"tags": [
"DeviceIntegrity"
]
}
},
"/api/v1/devices/{id}/integrity-step-ups": {
"post": {
"operationId": "DeviceIntegrityStepUp_Open",
"parameters": [
{
"description": "This device's registration ID.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/*+json": {
"example": {
"bodyDigest": "string",
"method": "string",
"path": "string"
},
"schema": {
"$ref": "#/components/schemas/OpenDeviceIntegrityStepUpRequest"
}
},
"application/json": {
"example": {
"bodyDigest": "string",
"method": "string",
"path": "string"
},
"schema": {
"$ref": "#/components/schemas/OpenDeviceIntegrityStepUpRequest"
}
},
"text/json": {
"example": {
"bodyDigest": "string",
"method": "string",
"path": "string"
},
"schema": {
"$ref": "#/components/schemas/OpenDeviceIntegrityStepUpRequest"
}
}
},
"description": "The refused request's method, path and base64url SHA-256 body digest."
},
"responses": {
"201": {
"content": {
"application/json": {
"example": {
"bodyDigest": "string",
"createdAt": "2026-01-01T00:00:00.0000000+00:00",
"decidedByDeviceRegistrationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"expiresAt": "2026-01-01T00:00:00.0000000+00:00",
"method": "string",
"path": "string",
"peerProof": "string",
"requestingDeviceName": "string",
"requestingDeviceRegistrationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": "string",
"stepUpRequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"schema": {
"$ref": "#/components/schemas/DeviceIntegrityStepUpResponse"
}
}
},
"description": "Opened; poll `GET {id}/integrity-step-ups/{stepUpRequestId}` for the decision."
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Not a request the relay can carry (method, path or digest)."
},
"403": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "The route's device is not this session's."
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Device not found or not owned by the caller."
},
"409": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "This device already has the maximum number of requests waiting."
}
},
"summary": "This device asks another of the account's devices to approve the key-custody request it was\r\njust refused. Carries the request's method, path and body DIGEST — never the body.",
"tags": [
"DeviceIntegrityStepUp"
]
}
},
"/api/v1/devices/{id}/integrity-step-ups/pending": {
"get": {
"operationId": "DeviceIntegrityStepUp_ListPending",
"parameters": [
{
"description": "This device's registration ID.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"requests": []
},
"schema": {
"$ref": "#/components/schemas/DeviceIntegrityStepUpListResponse"
}
}
},
"description": "Oldest first; empty when nothing is waiting."
},
"403": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "The route's device is not this session's."
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Device not found or not owned by the caller."
}
},
"summary": "The requests other devices of this account are waiting for THIS device to decide.",
"tags": [
"DeviceIntegrityStepUp"
]
}
},
"/api/v1/devices/{id}/integrity-step-ups/{requestId}": {
"get": {
"operationId": "DeviceIntegrityStepUp_Get",
"parameters": [
{
"description": "This device's registration ID.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"description": "The step-up request.",
"in": "path",
"name": "requestId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"bodyDigest": "string",
"createdAt": "2026-01-01T00:00:00.0000000+00:00",
"decidedByDeviceRegistrationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"expiresAt": "2026-01-01T00:00:00.0000000+00:00",
"method": "string",
"path": "string",
"peerProof": "string",
"requestingDeviceName": "string",
"requestingDeviceRegistrationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": "string",
"stepUpRequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"schema": {
"$ref": "#/components/schemas/DeviceIntegrityStepUpResponse"
}
}
},
"description": "The request and its status."
},
"403": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "The route's device is not this session's."
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "No such request opened by this device."
}
},
"summary": "This device reads back a request it opened. Once `approved`, `peerProof` is the value to\r\nretry with on `X-Device-Peer-Proof`.",
"tags": [
"DeviceIntegrityStepUp"
]
}
},
"/api/v1/devices/{id}/integrity-step-ups/{requestId}/approval": {
"post": {
"operationId": "DeviceIntegrityStepUp_Approve",
"parameters": [
{
"description": "This (approving) device's registration ID.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"description": "The step-up request.",
"in": "path",
"name": "requestId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/*+json": {
"example": {
"proof": "string"
},
"schema": {
"$ref": "#/components/schemas/ApproveDeviceIntegrityStepUpRequest"
}
},
"application/json": {
"example": {
"proof": "string"
},
"schema": {
"$ref": "#/components/schemas/ApproveDeviceIntegrityStepUpRequest"
}
},
"text/json": {
"example": {
"proof": "string"
},
"schema": {
"$ref": "#/components/schemas/ApproveDeviceIntegrityStepUpRequest"
}
}
},
"description": "The peer proof."
},
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"bodyDigest": "string",
"createdAt": "2026-01-01T00:00:00.0000000+00:00",
"decidedByDeviceRegistrationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"expiresAt": "2026-01-01T00:00:00.0000000+00:00",
"method": "string",
"path": "string",
"peerProof": "string",
"requestingDeviceName": "string",
"requestingDeviceRegistrationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": "string",
"stepUpRequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"schema": {
"$ref": "#/components/schemas/DeviceIntegrityStepUpResponse"
}
}
},
"description": "Approved."
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "The proof would not satisfy the request; `peerReason` says why."
},
"403": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "The route's device is not this session's, or it is the requesting device."
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "No such request on this account."
},
"409": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Already decided or lapsed."
}
},
"summary": "This device approves another device's request with a peer proof signed by its own enrolled key,\r\nover a fresh `Proof` challenge from `POST {id}/challenges`, bound to the request's method,\r\npath and body digest. Checked here (all but spending the nonce) so a proof that would fail is\r\nrefused now, on this device's screen.",
"tags": [
"DeviceIntegrityStepUp"
]
}
},
"/api/v1/devices/{id}/integrity-step-ups/{requestId}/decline": {
"post": {
"operationId": "DeviceIntegrityStepUp_Decline",
"parameters": [
{
"description": "This (declining) device's registration ID.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"description": "The step-up request.",
"in": "path",
"name": "requestId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"bodyDigest": "string",
"createdAt": "2026-01-01T00:00:00.0000000+00:00",
"decidedByDeviceRegistrationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"expiresAt": "2026-01-01T00:00:00.0000000+00:00",
"method": "string",
"path": "string",
"peerProof": "string",
"requestingDeviceName": "string",
"requestingDeviceRegistrationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": "string",
"stepUpRequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"schema": {
"$ref": "#/components/schemas/DeviceIntegrityStepUpResponse"
}
}
},
"description": "Declined."
},
"403": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "The route's device is not this session's, or it is the requesting device."
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "No such request on this account."
},
"409": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Already decided or lapsed."
}
},
"summary": "This device's holder declines another device's request.",
"tags": [
"DeviceIntegrityStepUp"
]
}
},
"/api/v1/devices/{id}/key-exchange-key/rotation": {
"post": {
"description": "Only the PUBLIC half of the new key is sent. The request must carry an X-Device-Proof verified\r\nagainst THIS registration's enrolled signing key, whatever the possession rollout mode: the\r\nkey-exchange key is what the next master-key rotation is wrapped to, so a bearer token alone\r\nmust not be able to move it.",
"operationId": "DeviceKeyRotation_RotateKeyExchangeKey",
"parameters": [
{
"description": "This device's registration ID.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/*+json": {
"example": {
"publicKey": "string"
},
"schema": {
"$ref": "#/components/schemas/RotateDeviceKeyExchangeKeyRequest"
}
},
"application/json": {
"example": {
"publicKey": "string"
},
"schema": {
"$ref": "#/components/schemas/RotateDeviceKeyExchangeKeyRequest"
}
},
"text/json": {
"example": {
"publicKey": "string"
},
"schema": {
"$ref": "#/components/schemas/RotateDeviceKeyExchangeKeyRequest"
}
}
},
"description": "The new key-exchange public key (JWK)."
},
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"deviceRegistrationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"publicKeyFingerprint": "string",
"rotatedAt": "2026-01-01T00:00:00.0000000+00:00"
},
"schema": {
"$ref": "#/components/schemas/DeviceKeyExchangeKeyRotationResponse"
}
}
},
"description": "Key rotated; the completion instant and new key fingerprint are returned."
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Not a public JWK, or the token carries no user."
},
"401": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "No X-Device-Proof verified against this device's enrolled key."
},
"403": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "The proof came from another device of the account."
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Device not found, inactive, or not owned by the caller."
},
"409": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "The key is unchanged, or a master-key rotation is still in progress or being delivered."
}
},
"summary": "Replaces this device's key-exchange public key with one it has just generated, and returns the\r\ninstant the rotation completed.",
"tags": [
"DeviceKeyRotation"
]
}
},
"/api/v1/devices/{id}/pending-rotation": {
"get": {
"operationId": "Devices_GetPendingKeyRotation",
"parameters": [
{
"description": "Device registration ID.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"queuedAt": "2026-01-01T00:00:00.0000000+00:00",
"rotationSessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"wrappedKeyMaterial": "string"
},
"schema": {
"$ref": "#/components/schemas/PendingKeyRotationResponse"
}
}
},
"description": "Pending wrapped key material returned."
},
"204": {
"description": "No pending rotation for this device."
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Device not found or not owned by caller."
},
"500": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Internal Server Error"
}
},
"summary": "Returns the pending wrapped-UMK blob queued for this device by\r\nthe rotation initiator (FR-01.016), or 204 when the queue is\r\nempty. Siblings poll this endpoint after a\r\n`KeyRotationCompletedIntegrationEvent` or on periodic sync.",
"tags": [
"Devices"
]
}
},
"/api/v1/devices/{id}/pending-rotation/ack": {
"post": {
"operationId": "Devices_AcknowledgePendingKeyRotation",
"parameters": [
{
"description": "Device registration ID.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/*+json": {
"example": {
"rotationSessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"schema": {
"$ref": "#/components/schemas/AcknowledgePendingKeyRotationRequest"
}
},
"application/json": {
"example": {
"rotationSessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"schema": {
"$ref": "#/components/schemas/AcknowledgePendingKeyRotationRequest"
}
},
"text/json": {
"example": {
"rotationSessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"schema": {
"$ref": "#/components/schemas/AcknowledgePendingKeyRotationRequest"
}
}
},
"description": "Ack payload containing the rotation session ID."
},
"responses": {
"204": {
"description": "Acknowledgement accepted."
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Session fencing mismatch."
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Device not found or not owned by caller."
},
"500": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Internal Server Error"
}
},
"summary": "Acknowledges that the sibling device has unwrapped the queued\r\nUMK locally and committed it to its own keystore (FR-01.016).\r\nClears the pending-rotation queue on the device registration row.",
"tags": [
"Devices"
]
}
},
"/api/v1/devices/{id}/secure-wipe": {
"post": {
"operationId": "Devices_SecureWipeDevice",
"parameters": [
{
"description": "Device registration ID.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/*+json": {
"example": {
"attesterClass": "string",
"attesterLabel": "string",
"confirmationAcknowledged": false,
"signatureAlgorithm": "string",
"signatureThumbprint": "string",
"wipeStandardClaimed": "string"
},
"schema": {
"$ref": "#/components/schemas/SecureWipeDeviceRequest"
}
},
"application/json": {
"example": {
"attesterClass": "string",
"attesterLabel": "string",
"confirmationAcknowledged": false,
"signatureAlgorithm": "string",
"signatureThumbprint": "string",
"wipeStandardClaimed": "string"
},
"schema": {
"$ref": "#/components/schemas/SecureWipeDeviceRequest"
}
},
"text/json": {
"example": {
"attesterClass": "string",
"attesterLabel": "string",
"confirmationAcknowledged": false,
"signatureAlgorithm": "string",
"signatureThumbprint": "string",
"wipeStandardClaimed": "string"
},
"schema": {
"$ref": "#/components/schemas/SecureWipeDeviceRequest"
}
}
},
"description": "Secure-wipe request carrying the confirmation acknowledgement."
},
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"algorithm": "string",
"attestationDigest": "string",
"attestationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"attesterClass": "string",
"attesterLabel": "string",
"deviceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"deviceIdentifier": "string",
"deviceName": "string",
"isRevoked": false,
"revocationReason": "string",
"revokedAt": "2026-01-01T00:00:00.0000000+00:00",
"signatureAlgorithm": "string",
"signatureThumbprint": "string",
"statement": "string",
"wipeStandardClaimed": "string",
"wipedAt": "2026-01-01T00:00:00.0000000+00:00"
},
"schema": {
"$ref": "#/components/schemas/WipeAttestationResponse"
}
}
},
"description": "Device securely wiped; attestation returned."
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Confirmation not acknowledged or invalid request."
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Device not found or not owned by caller."
},
"500": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Internal Server Error"
}
},
"summary": "Securely wipes a device in preparation for resale / trade-in\r\n(FR-01.060-distinct \"Prepare for resale\", debt-2026-06-18-315). Revokes the device's\r\ncryptographic access via the authoritative FR-01.049 removal path and returns a\r\ntamper-evident wipe attestation. Distinct from account deletion (FR-01.060): only this\r\ndevice loses access; the account and its other devices are untouched. The plain-language\r\nconfirmation gate is enforced server-side — Essence.Core.MultiDeviceSync.Contracts.Requests.SecureWipeDeviceRequest.ConfirmationAcknowledged\r\nmust be `true` or the request is rejected with 400.",
"tags": [
"Devices"
]
}
},
"/api/v1/devices/{id}/signing-key": {
"put": {
"operationId": "Devices_EnrolSigningKey",
"parameters": [
{
"description": "Device registration ID.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/*+json": {
"example": {
"enrolmentProof": "string",
"pairingSessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"recoveryEnrolmentTicket": "string",
"signingKeyJwk": "string"
},
"schema": {
"$ref": "#/components/schemas/EnrolDeviceSigningKeyRequest"
}
},
"application/json": {
"example": {
"enrolmentProof": "string",
"pairingSessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"recoveryEnrolmentTicket": "string",
"signingKeyJwk": "string"
},
"schema": {
"$ref": "#/components/schemas/EnrolDeviceSigningKeyRequest"
}
},
"text/json": {
"example": {
"enrolmentProof": "string",
"pairingSessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"recoveryEnrolmentTicket": "string",
"signingKeyJwk": "string"
},
"schema": {
"$ref": "#/components/schemas/EnrolDeviceSigningKeyRequest"
}
}
},
"description": "The public signing JWK, its enrolment proof, and (for a paired device) the approving session."
},
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"deviceId": "string",
"deviceName": "string",
"deviceType": "string",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"isActive": false,
"lastSeenAt": "2026-01-01T00:00:00.0000000+00:00",
"publicKey": "string",
"registeredAt": "2026-01-01T00:00:00.0000000+00:00",
"signingKeyEnrolledAt": "2026-01-01T00:00:00.0000000+00:00",
"signingKeyEnrolmentMethod": "string",
"signingKeyThumbprint": "string",
"suspectedLostAt": "2026-01-01T00:00:00.0000000+00:00",
"suspectedLostRecoverySessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"schema": {
"$ref": "#/components/schemas/DeviceRegistrationResponse"
}
}
},
"description": "Signing key enrolled; the updated registration is returned."
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Not a public P-256 JWK, or the token carries no device_id."
},
"401": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "The enrolment proof did not verify, or its challenge was unknown, spent or expired."
},
"403": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Not authorised to enrol this way (pair from an enrolled device)."
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Device not found or not owned by the caller."
},
"409": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "A key is already enrolled, or this session's device is bound elsewhere."
}
},
"summary": "Enrols this device's ES256 signing key (SEC-009(a)) — the key every later key-custody request\r\nproves possession of. Needs an `Enrolment` challenge signed by the new key, and the\r\nserver's authority rule: the account's sole device, a pairing approval by an enrolled peer\r\n(`pairingSessionId`), a completed recovery on this device (for a recovery-phrase\r\nrecovery, the `recoveryEnrolmentTicket` its re-wrap returned, #18062), or a one-time\r\nlegacy attach inside the grace window.",
"tags": [
"Devices"
]
}
},
"/api/v1/devices/{id}/sync-status": {
"get": {
"operationId": "Devices_GetDeviceSyncStatus",
"parameters": [
{
"description": "Device registration ID",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"deviceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"isOnline": false,
"keyGeneration": 0,
"lastSyncedAt": "2026-01-01T00:00:00.0000000+00:00",
"pendingUpdates": 0
},
"schema": {
"$ref": "#/components/schemas/DeviceSyncStatusResponse"
}
}
},
"description": "Sync status retrieved"
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Device not found"
},
"500": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Internal Server Error"
}
},
"summary": "Gets the sync status for a specific device (FR-01.016).",
"tags": [
"Devices"
]
}
},
"/api/v1/emergency-access-anchors": {
"get": {
"operationId": "EmergencyAccessAnchors_List",
"parameters": [
{
"description": "Only anchors from this sovereign.",
"in": "query",
"name": "originInstanceId",
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"description": "Only anchors that occurred at or after this instant (UTC).",
"in": "query",
"name": "from",
"schema": {
"format": "date-time",
"type": "string"
}
},
{
"description": "Only anchors that occurred before this instant (UTC).",
"in": "query",
"name": "to",
"schema": {
"format": "date-time",
"type": "string"
}
},
{
"description": "Only the phases of this session (64-char lowercase-hex token).",
"in": "query",
"name": "sessionRef",
"schema": {
"type": "string"
}
},
{
"description": "`requested` | `granted` | `expired` | `revoked`.",
"in": "query",
"name": "phase",
"schema": {
"type": "string"
}
},
{
"description": "The previous page's `NextCursor`.",
"in": "query",
"name": "cursor",
"schema": {
"type": "string"
}
},
{
"description": "Page size (default 50, max 200).",
"in": "query",
"name": "limit",
"schema": {
"format": "int32",
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"hasMore": false,
"items": [],
"nextCursor": "string",
"pageSize": 0,
"previousCursor": "string"
},
"schema": {
"$ref": "#/components/schemas/EmergencyAccessAnchorResponseCursorResult"
}
}
},
"description": "One page of anchors."
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "A filter or the cursor is malformed, or the window ends before it starts."
}
},
"summary": "Lists recorded break-glass anchors, newest first, keyset-paginated (DAT-006).",
"tags": [
"EmergencyAccessAnchors"
]
}
},
"/api/v1/emergency-card-reads": {
"post": {
"operationId": "EmergencyCardRead_RecordRead",
"requestBody": {
"content": {
"application/*+json": {
"example": {
"channel": "string",
"disclosureLevel": "string",
"instanceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"nominatedContactUserIds": [],
"occurredAt": "2026-01-01T00:00:00.0000000+00:00",
"responderType": "string",
"subjectUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"schema": {
"$ref": "#/components/schemas/RecordEmergencyCardReadRequest"
}
},
"application/json": {
"example": {
"channel": "string",
"disclosureLevel": "string",
"instanceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"nominatedContactUserIds": [],
"occurredAt": "2026-01-01T00:00:00.0000000+00:00",
"responderType": "string",
"subjectUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"schema": {
"$ref": "#/components/schemas/RecordEmergencyCardReadRequest"
}
},
"text/json": {
"example": {
"channel": "string",
"disclosureLevel": "string",
"instanceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"nominatedContactUserIds": [],
"occurredAt": "2026-01-01T00:00:00.0000000+00:00",
"responderType": "string",
"subjectUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"schema": {
"$ref": "#/components/schemas/RecordEmergencyCardReadRequest"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"example": {
"anchorId": "string",
"anchoredHash": "string",
"notifiedRecipientCount": 0,
"occurredAt": "2026-01-01T00:00:00.0000000+00:00",
"readEventId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"schema": {
"$ref": "#/components/schemas/EmergencyCardReadResponse"
}
}
},
"description": "Created"
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Forbidden"
},
"503": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Service Unavailable"
}
},
"summary": "Records a wearable emergency-card read (FR-01.040/041). Anchors the read to\r\nEPIC 4 and queues the CRITICAL owner + nominated-contact notification in one\r\nunit of work; returns only when both committed.",
"tags": [
"EmergencyCardRead"
]
}
},
"/api/v1/escrow/approvers": {
"get": {
"operationId": "ApproverDirectory_List",
"parameters": [
{
"in": "query",
"name": "tenantId",
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "cursor",
"schema": {
"format": "date-time",
"type": "string"
}
},
{
"in": "query",
"name": "limit",
"schema": {
"format": "int32",
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"approvers": [],
"nextCursor": "2026-01-01T00:00:00.0000000+00:00"
},
"schema": {
"$ref": "#/components/schemas/ApproverDirectoryListResponse"
}
}
},
"description": "OK"
},
"401": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Forbidden"
}
},
"summary": "Lists the live FR-01.080 quorum-membership set (FR-01.093(b)).",
"tags": [
"ApproverDirectory"
]
},
"post": {
"operationId": "ApproverDirectory_Enrol",
"requestBody": {
"content": {
"application/*+json": {
"example": {
"approverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"attestation": "string",
"credentialPin": "string",
"credentialType": "string",
"effectiveFrom": "2026-01-01T00:00:00.0000000+00:00",
"effectiveUntil": "2026-01-01T00:00:00.0000000+00:00",
"tenantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"schema": {
"$ref": "#/components/schemas/EnrolApproverRequest"
}
},
"application/json": {
"example": {
"approverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"attestation": "string",
"credentialPin": "string",
"credentialType": "string",
"effectiveFrom": "2026-01-01T00:00:00.0000000+00:00",
"effectiveUntil": "2026-01-01T00:00:00.0000000+00:00",
"tenantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"schema": {
"$ref": "#/components/schemas/EnrolApproverRequest"
}
},
"text/json": {
"example": {
"approverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"attestation": "string",
"credentialPin": "string",
"credentialType": "string",
"effectiveFrom": "2026-01-01T00:00:00.0000000+00:00",
"effectiveUntil": "2026-01-01T00:00:00.0000000+00:00",
"tenantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"schema": {
"$ref": "#/components/schemas/EnrolApproverRequest"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"example": {
"approverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"createdAt": "2026-01-01T00:00:00.0000000+00:00",
"credentialType": "string",
"effectiveFrom": "2026-01-01T00:00:00.0000000+00:00",
"effectiveUntil": "2026-01-01T00:00:00.0000000+00:00",
"enrolmentAdminId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"entryId": "string",
"isQuarantined": false,
"signingKeyId": "string",
"tenantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"schema": {
"$ref": "#/components/schemas/ApproverDirectoryEntryResponse"
}
}
},
"description": "Created"
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Forbidden"
},
"409": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Conflict"
}
},
"summary": "Enrols a new break-glass approver (FR-01.093(b), AC-01.084).",
"tags": [
"ApproverDirectory"
]
}
},
"/api/v1/escrow/approvers/{approverId}": {
"delete": {
"operationId": "ApproverDirectory_Deprovision",
"parameters": [
{
"in": "path",
"name": "approverId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "tenantId",
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "reason",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"approverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"quorumsReverted": 0
},
"schema": {
"$ref": "#/components/schemas/DeprovisionApproverResult"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Not Found"
}
},
"summary": "Deprovisions an approver (soft-delete) and re-evaluates any in-flight\r\nreconstruction quorum the approver was part of (FR-01.093(c), AC-01.134).",
"tags": [
"ApproverDirectory"
]
}
},
"/api/v1/escrow/approvers/{approverId}/pin": {
"put": {
"operationId": "ApproverDirectory_RotatePin",
"parameters": [
{
"in": "path",
"name": "approverId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/*+json": {
"example": {
"attestation": "string",
"credentialPin": "string",
"tenantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"schema": {
"$ref": "#/components/schemas/RotateApproverPinRequest"
}
},
"application/json": {
"example": {
"attestation": "string",
"credentialPin": "string",
"tenantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"schema": {
"$ref": "#/components/schemas/RotateApproverPinRequest"
}
},
"text/json": {
"example": {
"attestation": "string",
"credentialPin": "string",
"tenantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"schema": {
"$ref": "#/components/schemas/RotateApproverPinRequest"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"approverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"createdAt": "2026-01-01T00:00:00.0000000+00:00",
"credentialType": "string",
"effectiveFrom": "2026-01-01T00:00:00.0000000+00:00",
"effectiveUntil": "2026-01-01T00:00:00.0000000+00:00",
"enrolmentAdminId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"entryId": "string",
"isQuarantined": false,
"signingKeyId": "string",
"tenantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"schema": {
"$ref": "#/components/schemas/ApproverDirectoryEntryResponse"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Not Found"
},
"409": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Conflict"
}
},
"summary": "Rotates an approver's credential pin after the underlying credential\r\nrotates (FR-01.093(c)).",
"tags": [
"ApproverDirectory"
]
}
},
"/api/v1/escrow/audit": {
"get": {
"operationId": "EscrowEnrolment_GetAuditChain",
"parameters": [
{
"description": "Optional enrolment scope.",
"in": "query",
"name": "enrolmentId",
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"description": "Opaque cursor from a previous page (null for first page).",
"in": "query",
"name": "cursor",
"schema": {
"type": "string"
}
},
{
"description": "Page size (default 500, max 1000). Values <=0 fall back to the default.",
"in": "query",
"name": "limit",
"schema": {
"format": "int32",
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"entries": [],
"hasMore": false,
"headHash": "string",
"nextCursor": "string",
"pageSize": 0
},
"schema": {
"$ref": "#/components/schemas/EscrowAuditChainResponse"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Forbidden"
}
},
"summary": "Returns the tamper-evident escrow audit chain (CC-061, FR-01.038).\r\nKeyset-paged per DAT-006 — callers resume by passing the previous\r\nresponse's `NextCursor` back in the cursor\r\nquery param. Optionally scoped to a single `enrolmentId`.",
"tags": [
"EscrowEnrolment"
]
}
},
"/api/v1/escrow/audit/verify": {
"get": {
"operationId": "EscrowEnrolment_VerifyAuditChain",
"parameters": [
{
"in": "query",
"name": "enrolmentId",
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"entriesChecked": 0,
"failureReason": "string",
"firstFailureEntryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"firstFailureIndex": 0,
"isValid": false
},
"schema": {
"$ref": "#/components/schemas/EscrowAuditChainVerificationResponse"
}
}
},
"description": "OK"
},
"401": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Forbidden"
}
},
"summary": "Re-verifies the stored audit chain hashes (CC-061, FR-01.038). Does\r\nnot mutate state; returns the verification outcome regardless of\r\nvalidity so operators can diagnose the first failing entry.",
"tags": [
"EscrowEnrolment"
]
}
},
"/api/v1/escrow/break-glass-consents": {
"get": {
"operationId": "BreakGlassConsent_List",
"parameters": [
{
"in": "query",
"name": "cursor",
"schema": {
"format": "date-time",
"type": "string"
}
},
{
"in": "query",
"name": "limit",
"schema": {
"format": "int32",
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"consents": [],
"nextCursor": "2026-01-01T00:00:00.0000000+00:00"
},
"schema": {
"$ref": "#/components/schemas/BreakGlassConsentListResponse"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Unauthorized"
}
},
"summary": "Lists the caller's live break-glass escrow consents (FR-01.030).",
"tags": [
"BreakGlassConsent"
]
},
"post": {
"operationId": "BreakGlassConsent_Record",
"requestBody": {
"content": {
"application/*+json": {
"example": {
"granteeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"granteeLabel": "string",
"granteeType": "string",
"holderLabel": "string",
"legalBasis": "string",
"purpose": "string",
"scopeCategories": [],
"tenantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"windowEnd": "2026-01-01T00:00:00.0000000+00:00",
"windowStart": "2026-01-01T00:00:00.0000000+00:00"
},
"schema": {
"$ref": "#/components/schemas/RecordBreakGlassConsentRequest"
}
},
"application/json": {
"example": {
"granteeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"granteeLabel": "string",
"granteeType": "string",
"holderLabel": "string",
"legalBasis": "string",
"purpose": "string",
"scopeCategories": [],
"tenantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"windowEnd": "2026-01-01T00:00:00.0000000+00:00",
"windowStart": "2026-01-01T00:00:00.0000000+00:00"
},
"schema": {
"$ref": "#/components/schemas/RecordBreakGlassConsentRequest"
}
},
"text/json": {
"example": {
"granteeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"granteeLabel": "string",
"granteeType": "string",
"holderLabel": "string",
"legalBasis": "string",
"purpose": "string",
"scopeCategories": [],
"tenantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"windowEnd": "2026-01-01T00:00:00.0000000+00:00",
"windowStart": "2026-01-01T00:00:00.0000000+00:00"
},
"schema": {
"$ref": "#/components/schemas/RecordBreakGlassConsentRequest"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"example": {
"consentId": "string",
"granteeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"granteeLabel": "string",
"granteeType": "string",
"holderLabel": "string",
"homeRegion": "string",
"legalBasis": "string",
"legalBasisLabel": "string",
"ownerUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"purpose": "string",
"recordedAt": "2026-01-01T00:00:00.0000000+00:00",
"scopeCategories": [],
"status": "string",
"tenantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"windowEnd": "2026-01-01T00:00:00.0000000+00:00",
"windowStart": "2026-01-01T00:00:00.0000000+00:00",
"withdrawalReason": "string",
"withdrawnAt": "2026-01-01T00:00:00.0000000+00:00"
},
"schema": {
"$ref": "#/components/schemas/BreakGlassConsentResponse"
}
}
},
"description": "Created"
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Unauthorized"
},
"409": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Conflict"
}
},
"summary": "Records a durable break-glass escrow consent for the caller (FR-01.030).",
"tags": [
"BreakGlassConsent"
]
}
},
"/api/v1/escrow/break-glass-consents/export": {
"get": {
"operationId": "BreakGlassConsent_Export",
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"article": "string",
"entries": [],
"generatedAt": "2026-01-01T00:00:00.0000000+00:00",
"ownerUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"record": "string"
},
"schema": {
"$ref": "#/components/schemas/BreakGlassConsentExportResponse"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Unauthorized"
}
},
"summary": "Exports the caller's break-glass escrow consents as a GDPR Article-15 record (FR-01.030).",
"tags": [
"BreakGlassConsent"
]
}
},
"/api/v1/escrow/break-glass-consents/granted": {
"get": {
"description": "Every other action on this controller is the owner's. This one is not, so it carries the\r\norg-attribution edge gate the requester's `POST /escrow/reconstruct` carries, and the\r\nload-bearing binding is the caller's membership of the organisation it names (403 otherwise).\r\n#22847: includes the consents held on every peer sovereign this instance is configured to ask,\r\neach stamped with its `homeRegion`, and names the peers that could not be asked.\r\nlocalOnly is set by such a peer read so it never fans out again.",
"operationId": "BreakGlassConsent_ListGranted",
"parameters": [
{
"in": "query",
"name": "organizationId",
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "cursor",
"schema": {
"format": "date-time",
"type": "string"
}
},
{
"in": "query",
"name": "limit",
"schema": {
"format": "int32",
"type": "integer"
}
},
{
"in": "query",
"name": "localOnly",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"consents": [],
"nextCursor": "2026-01-01T00:00:00.0000000+00:00",
"unreachableRegions": []
},
"schema": {
"$ref": "#/components/schemas/BreakGlassGrantedConsentListResponse"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Forbidden"
}
},
"summary": "The GRANTEE's read (#22511): the consents in force that name organizationId\r\nas the responder organisation. A requester picks the account holder here and opens the\r\nbreak-glass request by subject — it never has to be handed an internal enrolment id.",
"tags": [
"BreakGlassConsent"
]
}
},
"/api/v1/escrow/break-glass-consents/{consentId}": {
"delete": {
"operationId": "BreakGlassConsent_Withdraw",
"parameters": [
{
"in": "path",
"name": "consentId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "reason",
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Unauthorized"
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Not Found"
}
},
"summary": "Withdraws one of the caller's break-glass escrow consents (FR-01.030).",
"tags": [
"BreakGlassConsent"
]
}
},
"/api/v1/escrow/break-glass-consents/{consentId}/holder-label": {
"patch": {
"operationId": "BreakGlassConsent_SetHolderLabel",
"parameters": [
{
"in": "path",
"name": "consentId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/*+json": {
"example": {
"holderLabel": "string"
},
"schema": {
"$ref": "#/components/schemas/SetBreakGlassConsentHolderLabelRequest"
}
},
"application/json": {
"example": {
"holderLabel": "string"
},
"schema": {
"$ref": "#/components/schemas/SetBreakGlassConsentHolderLabelRequest"
}
},
"text/json": {
"example": {
"holderLabel": "string"
},
"schema": {
"$ref": "#/components/schemas/SetBreakGlassConsentHolderLabelRequest"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"consentId": "string",
"granteeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"granteeLabel": "string",
"granteeType": "string",
"holderLabel": "string",
"homeRegion": "string",
"legalBasis": "string",
"legalBasisLabel": "string",
"ownerUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"purpose": "string",
"recordedAt": "2026-01-01T00:00:00.0000000+00:00",
"scopeCategories": [],
"status": "string",
"tenantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"windowEnd": "2026-01-01T00:00:00.0000000+00:00",
"windowStart": "2026-01-01T00:00:00.0000000+00:00",
"withdrawalReason": "string",
"withdrawnAt": "2026-01-01T00:00:00.0000000+00:00"
},
"schema": {
"$ref": "#/components/schemas/BreakGlassConsentResponse"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Unauthorized"
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Not Found"
},
"409": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Conflict"
}
},
"summary": "Sets, changes or clears the name the caller discloses to the grantee of one of their live\r\nconsents (#22862), without withdrawing it. `null` or blank clears it. Another user's\r\nconsent id is a 404.",
"tags": [
"BreakGlassConsent"
]
}
},
"/api/v1/escrow/break-glass-consents/{consentId}/scope": {
"patch": {
"operationId": "BreakGlassConsent_UpdateScope",
"parameters": [
{
"in": "path",
"name": "consentId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/*+json": {
"example": {
"scopeCategories": []
},
"schema": {
"$ref": "#/components/schemas/UpdateBreakGlassConsentScopeRequest"
}
},
"application/json": {
"example": {
"scopeCategories": []
},
"schema": {
"$ref": "#/components/schemas/UpdateBreakGlassConsentScopeRequest"
}
},
"text/json": {
"example": {
"scopeCategories": []
},
"schema": {
"$ref": "#/components/schemas/UpdateBreakGlassConsentScopeRequest"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"consentId": "string",
"granteeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"granteeLabel": "string",
"granteeType": "string",
"holderLabel": "string",
"homeRegion": "string",
"legalBasis": "string",
"legalBasisLabel": "string",
"ownerUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"purpose": "string",
"recordedAt": "2026-01-01T00:00:00.0000000+00:00",
"scopeCategories": [],
"status": "string",
"tenantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"windowEnd": "2026-01-01T00:00:00.0000000+00:00",
"windowStart": "2026-01-01T00:00:00.0000000+00:00",
"withdrawalReason": "string",
"withdrawnAt": "2026-01-01T00:00:00.0000000+00:00"
},
"schema": {
"$ref": "#/components/schemas/BreakGlassConsentResponse"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Unauthorized"
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Not Found"
},
"409": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Conflict"
}
},
"summary": "Replaces the per-category escrow scope of one of the caller's consents (FR-01.030).",
"tags": [
"BreakGlassConsent"
]
}
},
"/api/v1/escrow/configure": {
"post": {
"operationId": "EscrowEnrolment_Configure",
"requestBody": {
"content": {
"application/*+json": {
"example": {
"enrolmentId": "string",
"fingerprint": "string",
"shares": [],
"threshold": 0,
"totalShares": 0,
"wrappedVaultKeys": []
},
"schema": {
"$ref": "#/components/schemas/ConfigureEscrowRequest"
}
},
"application/json": {
"example": {
"enrolmentId": "string",
"fingerprint": "string",
"shares": [],
"threshold": 0,
"totalShares": 0,
"wrappedVaultKeys": []
},
"schema": {
"$ref": "#/components/schemas/ConfigureEscrowRequest"
}
},
"text/json": {
"example": {
"enrolmentId": "string",
"fingerprint": "string",
"shares": [],
"threshold": 0,
"totalShares": 0,
"wrappedVaultKeys": []
},
"schema": {
"$ref": "#/components/schemas/ConfigureEscrowRequest"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"example": {
"attestationStaleUnverified": false,
"belowReconstructionThresholdForDisplay": false,
"createdAt": "2026-01-01T00:00:00.0000000+00:00",
"displayAvailableHolderCount": 0,
"enrolmentId": "string",
"fingerprint": "string",
"freshnessWindowDays": 0,
"holders": [],
"revocationReason": "string",
"revokedAt": "2026-01-01T00:00:00.0000000+00:00",
"status": "string",
"threshold": 0,
"totalShares": 0,
"updatedAt": "2026-01-01T00:00:00.0000000+00:00",
"userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"vaultCategories": []
},
"schema": {
"$ref": "#/components/schemas/EscrowEnrolmentStatusResponse"
}
}
},
"description": "Created"
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Forbidden"
},
"409": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Conflict"
}
},
"summary": "Persists the Tier E-1 `EscrowEnrolmentArtefacts` tuple produced by\r\nthe client-side `enrolEmergencyAccessKey()` ceremony (CC-061,\r\nFR-01.031). Returns the masked enrolment summary.",
"tags": [
"EscrowEnrolment"
]
}
},
"/api/v1/escrow/emergency-access/history": {
"get": {
"operationId": "EmergencyAccessRequest_GetMyReleaseHistory",
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"events": [],
"generatedAt": "2026-01-01T00:00:00.0000000+00:00",
"subjectUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"schema": {
"$ref": "#/components/schemas/EmergencyAccessReleaseHistoryResponse"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Unauthorized"
}
},
"summary": "Returns the authenticated owner's escrow break-glass release / disclosure\r\nhistory (journey `emergency-credential-access-grant-on-inactivity`,\r\nFR-01.040 anchor / FR-01.041 notify; debt-2026-07-07-028). One anchored\r\nrecord per terminal event — invoker, ordered approval chain, tamper-evident\r\nevidence hash + EPIC 4 anchor reference, categories released, timestamps,\r\nand terminal outcome. Backs the essence-web `EmergencyAccessHistory`\r\nsurface. The subject is ALWAYS the authenticated caller (server-derived) —\r\nno client-supplied id participates in the authorisation decision.",
"tags": [
"EmergencyAccessRequest"
]
}
},
"/api/v1/escrow/emergency-access/history/{subjectUserId}": {
"get": {
"operationId": "EmergencyAccessRequest_ExportReleaseHistory",
"parameters": [
{
"in": "path",
"name": "subjectUserId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"events": [],
"generatedAt": "2026-01-01T00:00:00.0000000+00:00",
"subjectUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"schema": {
"$ref": "#/components/schemas/EmergencyAccessReleaseHistoryResponse"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Forbidden"
}
},
"summary": "Compliance / DPO export of a subject's escrow break-glass release history\r\n(FR-01.043 / FR-01.040-041; debt-2026-07-07-028). Gated to the\r\n`EscrowAuditExport` policy (`compliance-officer` / `platform-admin`) —\r\nthe same instance-wide compliance surface as the audit-chain export — so a\r\nregulator / DPO can pull the same disclosure the owner sees. Returns only\r\nnon-secret disclosure metadata; no decrypted credential is ever surfaced.",
"tags": [
"EmergencyAccessRequest"
]
}
},
"/api/v1/escrow/emergency-access/revoke-by-link": {
"post": {
"operationId": "EmergencyAccessRevokeLink_RevokeByLink",
"requestBody": {
"content": {
"application/*+json": {
"example": {
"expiresAtUnix": 0,
"sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"signature": "string",
"userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"schema": {
"$ref": "#/components/schemas/RevokeEmergencyAccessBySignedLinkRequest"
}
},
"application/json": {
"example": {
"expiresAtUnix": 0,
"sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"signature": "string",
"userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"schema": {
"$ref": "#/components/schemas/RevokeEmergencyAccessBySignedLinkRequest"
}
},
"text/json": {
"example": {
"expiresAtUnix": 0,
"sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"signature": "string",
"userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"schema": {
"$ref": "#/components/schemas/RevokeEmergencyAccessBySignedLinkRequest"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"alreadyEnded": false,
"endedAs": "string",
"endedAt": "2026-01-01T00:00:00.0000000+00:00",
"revoked": false
},
"schema": {
"$ref": "#/components/schemas/RevokeEmergencyAccessBySignedLinkResponse"
}
}
},
"description": "The grant is over — ended by this call, or already ended before it."
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "The link did not check out. Nothing was ended."
},
"410": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "The link is genuine but has expired. Nothing was ended."
},
"503": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "This instance cannot verify revoke links. Nothing was ended."
}
},
"summary": "End the emergency-access grant a receipt's \"Revoke now\" link names.",
"tags": [
"EmergencyAccessRevokeLink"
]
}
},
"/api/v1/escrow/enrolments/{id}": {
"get": {
"operationId": "EscrowEnrolment_GetEnrolment",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"attestationStaleUnverified": false,
"belowReconstructionThresholdForDisplay": false,
"createdAt": "2026-01-01T00:00:00.0000000+00:00",
"displayAvailableHolderCount": 0,
"enrolmentId": "string",
"fingerprint": "string",
"freshnessWindowDays": 0,
"holders": [],
"revocationReason": "string",
"revokedAt": "2026-01-01T00:00:00.0000000+00:00",
"status": "string",
"threshold": 0,
"totalShares": 0,
"updatedAt": "2026-01-01T00:00:00.0000000+00:00",
"userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"vaultCategories": []
},
"schema": {
"$ref": "#/components/schemas/EscrowEnrolmentStatusResponse"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Not Found"
}
},
"summary": "Returns a single enrolment by ID (masked). 404 when missing; the\r\nownership check is enforced in the handler and flows through the\r\nexception pipeline as 403 when the caller is not the owner.",
"tags": [
"EscrowEnrolment"
]
}
},
"/api/v1/escrow/enrolments/{id}/revoke": {
"post": {
"operationId": "EscrowEnrolment_RevokeEnrolment",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/*+json": {
"example": {
"reason": "string"
},
"schema": {
"$ref": "#/components/schemas/RevokeEscrowEnrolmentRequest"
}
},
"application/json": {
"example": {
"reason": "string"
},
"schema": {
"$ref": "#/components/schemas/RevokeEscrowEnrolmentRequest"
}
},
"text/json": {
"example": {
"reason": "string"
},
"schema": {
"$ref": "#/components/schemas/RevokeEscrowEnrolmentRequest"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"attestationStaleUnverified": false,
"belowReconstructionThresholdForDisplay": false,
"createdAt": "2026-01-01T00:00:00.0000000+00:00",
"displayAvailableHolderCount": 0,
"enrolmentId": "string",
"fingerprint": "string",
"freshnessWindowDays": 0,
"holders": [],
"revocationReason": "string",
"revokedAt": "2026-01-01T00:00:00.0000000+00:00",
"status": "string",
"threshold": 0,
"totalShares": 0,
"updatedAt": "2026-01-01T00:00:00.0000000+00:00",
"userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"vaultCategories": []
},
"schema": {
"$ref": "#/components/schemas/EscrowEnrolmentStatusResponse"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Not Found"
}
},
"summary": "Revokes an enrolment and cascades to any non-terminal reconstruction\r\nrequests (CC-061, FR-01.040). The enrolment's soft-delete flag frees\r\nthe partial unique index on `(user_id, is_deleted=false)` for\r\nre-enrolment.",
"tags": [
"EscrowEnrolment"
]
}
},
"/api/v1/escrow/holders": {
"get": {
"operationId": "ResponderHolder_List",
"parameters": [
{
"in": "query",
"name": "tenantId",
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "cursor",
"schema": {
"format": "date-time",
"type": "string"
}
},
{
"in": "query",
"name": "limit",
"schema": {
"format": "int32",
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"holders": [],
"nextCursor": "2026-01-01T00:00:00.0000000+00:00"
},
"schema": {
"$ref": "#/components/schemas/ResponderHolderListResponse"
}
}
},
"description": "OK"
},
"401": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Forbidden"
}
},
"summary": "Lists the live responder-holder organisations (FR-01.033).",
"tags": [
"ResponderHolder"
]
},
"post": {
"operationId": "ResponderHolder_Enrol",
"requestBody": {
"content": {
"application/*+json": {
"example": {
"credentialedClasses": [],
"holderRole": "string",
"organisationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"tenantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"schema": {
"$ref": "#/components/schemas/EnrolResponderHolderRequest"
}
},
"application/json": {
"example": {
"credentialedClasses": [],
"holderRole": "string",
"organisationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"tenantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"schema": {
"$ref": "#/components/schemas/EnrolResponderHolderRequest"
}
},
"text/json": {
"example": {
"credentialedClasses": [],
"holderRole": "string",
"organisationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"tenantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"schema": {
"$ref": "#/components/schemas/EnrolResponderHolderRequest"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"example": {
"createdAt": "2026-01-01T00:00:00.0000000+00:00",
"credentialedClasses": [],
"credentialedResponders": [],
"enrolmentAdminId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"holderId": "string",
"holderRole": "string",
"organisationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"revokedAt": "2026-01-01T00:00:00.0000000+00:00",
"status": "string",
"tenantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"schema": {
"$ref": "#/components/schemas/ResponderHolderResponse"
}
}
},
"description": "Created"
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Forbidden"
},
"409": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Conflict"
}
},
"summary": "Enrols an organisation as a break-glass escrow holder (FR-01.033).",
"tags": [
"ResponderHolder"
]
}
},
"/api/v1/escrow/holders/{organisationId}": {
"delete": {
"operationId": "ResponderHolder_Revoke",
"parameters": [
{
"in": "path",
"name": "organisationId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "tenantId",
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "reason",
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Not Found"
}
},
"summary": "Revokes an organisation's holder authority (FR-01.033).",
"tags": [
"ResponderHolder"
]
}
},
"/api/v1/escrow/holders/{organisationId}/responders": {
"post": {
"operationId": "ResponderHolder_CredentialResponder",
"parameters": [
{
"in": "path",
"name": "organisationId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/*+json": {
"example": {
"responderClass": "string",
"responderId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"tenantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"schema": {
"$ref": "#/components/schemas/CredentialResponderRequest"
}
},
"application/json": {
"example": {
"responderClass": "string",
"responderId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"tenantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"schema": {
"$ref": "#/components/schemas/CredentialResponderRequest"
}
},
"text/json": {
"example": {
"responderClass": "string",
"responderId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"tenantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"schema": {
"$ref": "#/components/schemas/CredentialResponderRequest"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"createdAt": "2026-01-01T00:00:00.0000000+00:00",
"credentialedClasses": [],
"credentialedResponders": [],
"enrolmentAdminId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"holderId": "string",
"holderRole": "string",
"organisationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"revokedAt": "2026-01-01T00:00:00.0000000+00:00",
"status": "string",
"tenantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"schema": {
"$ref": "#/components/schemas/ResponderHolderResponse"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Not Found"
},
"409": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Conflict"
}
},
"summary": "Credentials an individual responder under a holder organisation (FR-01.033).",
"tags": [
"ResponderHolder"
]
}
},
"/api/v1/escrow/holders/{organisationId}/responders/{responderId}": {
"delete": {
"operationId": "ResponderHolder_RevokeResponder",
"parameters": [
{
"in": "path",
"name": "organisationId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "responderId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "tenantId",
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "reason",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"createdAt": "2026-01-01T00:00:00.0000000+00:00",
"credentialedClasses": [],
"credentialedResponders": [],
"enrolmentAdminId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"holderId": "string",
"holderRole": "string",
"organisationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"revokedAt": "2026-01-01T00:00:00.0000000+00:00",
"status": "string",
"tenantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"schema": {
"$ref": "#/components/schemas/ResponderHolderResponse"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Not Found"
}
},
"summary": "Withdraws an individual responder's credentialing (FR-01.033).",
"tags": [
"ResponderHolder"
]
}
},
"/api/v1/escrow/reconstruct": {
"post": {
"operationId": "EmergencyAccessRequest_Reconstruct",
"requestBody": {
"content": {
"application/*+json": {
"example": {
"enrolmentId": "string",
"justification": "string",
"requesterPublicKeyJwk": "string",
"requestingOrgId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"resolveHereOnly": false,
"subjectUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"vaultCategory": "string"
},
"schema": {
"$ref": "#/components/schemas/RequestEscrowReconstructionRequest"
}
},
"application/json": {
"example": {
"enrolmentId": "string",
"justification": "string",
"requesterPublicKeyJwk": "string",
"requestingOrgId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"resolveHereOnly": false,
"subjectUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"vaultCategory": "string"
},
"schema": {
"$ref": "#/components/schemas/RequestEscrowReconstructionRequest"
}
},
"text/json": {
"example": {
"enrolmentId": "string",
"justification": "string",
"requesterPublicKeyJwk": "string",
"requestingOrgId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"resolveHereOnly": false,
"subjectUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"vaultCategory": "string"
},
"schema": {
"$ref": "#/components/schemas/RequestEscrowReconstructionRequest"
}
}
}
},
"responses": {
"202": {
"content": {
"application/json": {
"example": {
"approvalChallengeNonce": "string",
"enrolmentId": "string",
"expiresAt": "2026-01-01T00:00:00.0000000+00:00",
"requestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"requestedAt": "2026-01-01T00:00:00.0000000+00:00",
"status": "string"
},
"schema": {
"$ref": "#/components/schemas/EscrowReconstructionRequestResponse"
}
}
},
"description": "Accepted"
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Not Found"
},
"409": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Conflict"
}
},
"summary": "Opens a reconstruction request against a configured enrolment\r\n(CC-061, FR-01.035). The request is persisted in `requested`\r\nstate and an outbox event is published for Tier E-3 pickup.",
"tags": [
"EmergencyAccessRequest"
]
}
},
"/api/v1/escrow/requests/mine": {
"get": {
"description": "#22852: includes the requests this instance routed to their subjects' home sovereigns, read back\r\nfrom each one (status `unknown` when it cannot be asked). localOnly is set\r\nby such a read-back so it never fans out again.",
"operationId": "EmergencyAccessRequest_ListMyOpenRequests",
"parameters": [
{
"in": "query",
"name": "organizationId",
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "localOnly",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"requests": []
},
"schema": {
"$ref": "#/components/schemas/EscrowRequesterOpenRequestsResponse"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Forbidden"
}
},
"summary": "The caller's own break-glass requests for organizationId that can still be\r\nresumed (#22510): not reconstructed, not terminal, not past their deadline. A requester whose\r\ntab closed finds the request here; resuming it needs the ephemeral key their browser kept.\r\nPinned to the token's subject. Metadata only.",
"tags": [
"EmergencyAccessRequest"
]
}
},
"/api/v1/escrow/requests/mine/closed": {
"get": {
"operationId": "EmergencyAccessRequest_ListMyClosedRequests",
"parameters": [
{
"in": "query",
"name": "organizationId",
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"requests": []
},
"schema": {
"$ref": "#/components/schemas/EscrowRequesterClosedRequestsResponse"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Forbidden"
}
},
"summary": "The caller's own break-glass requests for organizationId that have closed\r\n(#22590): reconstructed, denied, revoked, or past their deadline. The complement of\r\nM:Essence.Core.MultiDeviceSync.Api.Controllers.EmergencyAccessRequestController.ListMyOpenRequests(System.Guid,System.Boolean,System.Threading.CancellationToken), so a requester can find a request again to re-read its\r\njustification without keeping the reference. Pinned to the token's subject. Metadata only.",
"tags": [
"EmergencyAccessRequest"
]
}
},
"/api/v1/escrow/requests/{id}": {
"get": {
"operationId": "EmergencyAccessRequest_GetReconstructionRequest",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"accessExpiresAt": "2026-01-01T00:00:00.0000000+00:00",
"accessExtensionChallengeNonce": "string",
"accessExtensionCount": 0,
"accessWindowCeiling": "2026-01-01T00:00:00.0000000+00:00",
"approvalChallengeNonce": "string",
"approvalCount": 0,
"earliestUnlockAt": "2026-01-01T00:00:00.0000000+00:00",
"enrolmentId": "string",
"expiresAt": "2026-01-01T00:00:00.0000000+00:00",
"requestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"shareSubmissionCount": 0,
"status": "string",
"updatedAt": "2026-01-01T00:00:00.0000000+00:00",
"zeroizationSignalledAt": "2026-01-01T00:00:00.0000000+00:00"
},
"schema": {
"$ref": "#/components/schemas/EscrowReconstructionLifecycleResponse"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Not Found"
}
},
"summary": "Returns the lifecycle snapshot for a reconstruction request (CC-061,\r\nFR-01.030 / FR-01.037). Pinned to the requester so the React hook\r\ncan poll without leaking lifecycle state to other parties.",
"tags": [
"EmergencyAccessRequest"
]
}
},
"/api/v1/escrow/requests/{id}/access-extension": {
"post": {
"operationId": "EmergencyAccessRequest_OpenAccessExtension",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"accessExpiresAt": "2026-01-01T00:00:00.0000000+00:00",
"accessExtensionChallengeNonce": "string",
"accessExtensionCount": 0,
"accessWindowCeiling": "2026-01-01T00:00:00.0000000+00:00",
"approvalChallengeNonce": "string",
"approvalCount": 0,
"earliestUnlockAt": "2026-01-01T00:00:00.0000000+00:00",
"enrolmentId": "string",
"expiresAt": "2026-01-01T00:00:00.0000000+00:00",
"requestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"shareSubmissionCount": 0,
"status": "string",
"updatedAt": "2026-01-01T00:00:00.0000000+00:00",
"zeroizationSignalledAt": "2026-01-01T00:00:00.0000000+00:00"
},
"schema": {
"$ref": "#/components/schemas/EscrowReconstructionLifecycleResponse"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Not Found"
},
"409": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Conflict"
}
},
"summary": "The requester asks for a live granted access window to be extended (FR-01.038(1), #22389).\r\nGrants no time: it opens an extension cycle and returns its fresh, single-use\r\n`accessExtensionChallengeNonce`, which the re-attestation quorum signs over via\r\n`POST /requests/{id}/access-extension/approve`. Refused with 409 when the window has\r\nelapsed or ended (FR-01.038(4): open a new request) or already stands at the 72 h cumulative\r\nmaximum (FR-01.038(2)).",
"tags": [
"EmergencyAccessRequest"
]
}
},
"/api/v1/escrow/requests/{id}/access-extension/approve": {
"post": {
"operationId": "EmergencyAccessRequest_ApproveAccessExtension",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/*+json": {
"example": {
"approvedAt": "2026-01-01T00:00:00.0000000+00:00",
"approverKeyId": "string",
"signatureBase64": "string"
},
"schema": {
"$ref": "#/components/schemas/ApproveEscrowReconstructionRequest"
}
},
"application/json": {
"example": {
"approvedAt": "2026-01-01T00:00:00.0000000+00:00",
"approverKeyId": "string",
"signatureBase64": "string"
},
"schema": {
"$ref": "#/components/schemas/ApproveEscrowReconstructionRequest"
}
},
"text/json": {
"example": {
"approvedAt": "2026-01-01T00:00:00.0000000+00:00",
"approverKeyId": "string",
"signatureBase64": "string"
},
"schema": {
"$ref": "#/components/schemas/ApproveEscrowReconstructionRequest"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"accessExpiresAt": "2026-01-01T00:00:00.0000000+00:00",
"accessExtensionChallengeNonce": "string",
"accessExtensionCount": 0,
"accessWindowCeiling": "2026-01-01T00:00:00.0000000+00:00",
"approvalChallengeNonce": "string",
"approvalCount": 0,
"earliestUnlockAt": "2026-01-01T00:00:00.0000000+00:00",
"enrolmentId": "string",
"expiresAt": "2026-01-01T00:00:00.0000000+00:00",
"requestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"shareSubmissionCount": 0,
"status": "string",
"updatedAt": "2026-01-01T00:00:00.0000000+00:00",
"zeroizationSignalledAt": "2026-01-01T00:00:00.0000000+00:00"
},
"schema": {
"$ref": "#/components/schemas/EscrowReconstructionLifecycleResponse"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Forbidden"
},
"409": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Conflict"
}
},
"summary": "Records one approver's Ed25519 re-attestation of an access-window extension\r\n(FR-01.038(1)-(3), #22389). The signed payload is\r\n`escrow-extend:{requestId:N}:{enrolmentId:N}:{approverUserId:N}:{cycle}:{approvedAt:O}:{accessExtensionChallengeNonce}`\r\nwhere `cycle` is `accessExtensionCount + 1`. The quorum-reaching re-attestation\r\nextends the window (cut to 72 h cumulative), seals an audit entry and notifies the account\r\nholder with `reason='extended'`.",
"tags": [
"EmergencyAccessRequest"
]
}
},
"/api/v1/escrow/requests/{id}/approve": {
"post": {
"operationId": "EmergencyAccessRequest_Approve",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "localOnly",
"schema": {
"type": "boolean"
}
}
],
"requestBody": {
"content": {
"application/*+json": {
"example": {
"approvedAt": "2026-01-01T00:00:00.0000000+00:00",
"approverKeyId": "string",
"signatureBase64": "string"
},
"schema": {
"$ref": "#/components/schemas/ApproveEscrowReconstructionRequest"
}
},
"application/json": {
"example": {
"approvedAt": "2026-01-01T00:00:00.0000000+00:00",
"approverKeyId": "string",
"signatureBase64": "string"
},
"schema": {
"$ref": "#/components/schemas/ApproveEscrowReconstructionRequest"
}
},
"text/json": {
"example": {
"approvedAt": "2026-01-01T00:00:00.0000000+00:00",
"approverKeyId": "string",
"signatureBase64": "string"
},
"schema": {
"$ref": "#/components/schemas/ApproveEscrowReconstructionRequest"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"accessExpiresAt": "2026-01-01T00:00:00.0000000+00:00",
"accessExtensionChallengeNonce": "string",
"accessExtensionCount": 0,
"accessWindowCeiling": "2026-01-01T00:00:00.0000000+00:00",
"approvalChallengeNonce": "string",
"approvalCount": 0,
"earliestUnlockAt": "2026-01-01T00:00:00.0000000+00:00",
"enrolmentId": "string",
"expiresAt": "2026-01-01T00:00:00.0000000+00:00",
"requestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"shareSubmissionCount": 0,
"status": "string",
"updatedAt": "2026-01-01T00:00:00.0000000+00:00",
"zeroizationSignalledAt": "2026-01-01T00:00:00.0000000+00:00"
},
"schema": {
"$ref": "#/components/schemas/EscrowReconstructionLifecycleResponse"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Not Found"
},
"409": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Conflict"
}
},
"summary": "Records an Ed25519 approval against an in-flight reconstruction\r\nrequest (CC-061, FR-01.037). When quorum is reached the aggregate\r\nstamps the FR-01.033 cool-off `EarliestUnlockAt`.",
"tags": [
"EmergencyAccessRequest"
]
}
},
"/api/v1/escrow/requests/{id}/complete": {
"post": {
"operationId": "EmergencyAccessRequest_CompleteReconstruction",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"accessExpiresAt": "2026-01-01T00:00:00.0000000+00:00",
"accessExtensionChallengeNonce": "string",
"accessExtensionCount": 0,
"accessWindowCeiling": "2026-01-01T00:00:00.0000000+00:00",
"approvalChallengeNonce": "string",
"approvalCount": 0,
"earliestUnlockAt": "2026-01-01T00:00:00.0000000+00:00",
"enrolmentId": "string",
"expiresAt": "2026-01-01T00:00:00.0000000+00:00",
"requestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"shareSubmissionCount": 0,
"status": "string",
"updatedAt": "2026-01-01T00:00:00.0000000+00:00",
"zeroizationSignalledAt": "2026-01-01T00:00:00.0000000+00:00"
},
"schema": {
"$ref": "#/components/schemas/EscrowReconstructionLifecycleResponse"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Not Found"
},
"409": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Conflict"
}
},
"summary": "Marks a reconstruction request as completed once the requester has\r\ncombined the relayed shares locally (CC-061, FR-01.030 / FR-01.037).\r\nThe aggregate enforces the FR-01.033 cool-off window — the call is\r\nrejected with 409 if invoked before `EarliestUnlockAt`.",
"tags": [
"EmergencyAccessRequest"
]
}
},
"/api/v1/escrow/requests/{id}/deny": {
"post": {
"operationId": "EmergencyAccessRequest_Deny",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "localOnly",
"schema": {
"type": "boolean"
}
}
],
"requestBody": {
"content": {
"application/*+json": {
"example": {
"reason": "string"
},
"schema": {
"$ref": "#/components/schemas/DenyEscrowReconstructionRequest"
}
},
"application/json": {
"example": {
"reason": "string"
},
"schema": {
"$ref": "#/components/schemas/DenyEscrowReconstructionRequest"
}
},
"text/json": {
"example": {
"reason": "string"
},
"schema": {
"$ref": "#/components/schemas/DenyEscrowReconstructionRequest"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"accessExpiresAt": "2026-01-01T00:00:00.0000000+00:00",
"accessExtensionChallengeNonce": "string",
"accessExtensionCount": 0,
"accessWindowCeiling": "2026-01-01T00:00:00.0000000+00:00",
"approvalChallengeNonce": "string",
"approvalCount": 0,
"earliestUnlockAt": "2026-01-01T00:00:00.0000000+00:00",
"enrolmentId": "string",
"expiresAt": "2026-01-01T00:00:00.0000000+00:00",
"requestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"shareSubmissionCount": 0,
"status": "string",
"updatedAt": "2026-01-01T00:00:00.0000000+00:00",
"zeroizationSignalledAt": "2026-01-01T00:00:00.0000000+00:00"
},
"schema": {
"$ref": "#/components/schemas/EscrowReconstructionLifecycleResponse"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Unauthorized"
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Not Found"
},
"409": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Conflict"
}
},
"summary": "Denies an in-flight reconstruction request (CC-061, FR-01.037). Any\r\nauthorised approver can burn the request; the aggregate transitions\r\nto `denied` and no further approvals or share submissions are\r\naccepted.",
"tags": [
"EmergencyAccessRequest"
]
}
},
"/api/v1/escrow/requests/{id}/justification": {
"get": {
"operationId": "EmergencyAccessRequest_GetJustification",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"justification": "string",
"readerRole": "string",
"requestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"state": "string"
},
"schema": {
"$ref": "#/components/schemas/EscrowReconstructionJustificationResponse"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Unauthorized"
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Not Found"
},
"500": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Internal Server Error"
},
"503": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Service Unavailable"
}
},
"summary": "Returns the decrypted justification of a reconstruction request to its subject or its\r\nrequester (FR-01.065 / FR-01.039, #22417), closed requests included. Anyone else, and an\r\nunknown id, get the same generic 404 and leave no trace on the audit chain; an\r\nauthorised read appends a `JustificationRead` entry. A purged request answers\r\n`state: \"purged\"`; a seal that fails authentication is a typed 500.",
"tags": [
"EmergencyAccessRequest"
]
}
},
"/api/v1/escrow/requests/{id}/reconstruction-material": {
"get": {
"operationId": "EmergencyAccessRequest_GetReconstructionMaterial",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"accessExpiresAt": "2026-01-01T00:00:00.0000000+00:00",
"enrolmentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"holders": [],
"requestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"threshold": 0,
"totalShares": 0,
"vaultKeyWraps": []
},
"schema": {
"$ref": "#/components/schemas/EscrowReconstructionMaterialResponse"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Not Found"
},
"409": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Conflict"
}
},
"summary": "Returns the enrolment material the requester's client needs to finish a\r\nreconstruction (CC-061, FR-01.037 / FR-01.039, #22335): the Shamir scheme,\r\nthe holder roster, and the scoped vault keys wrapped under the EAK.\r\nRequester only; released under the same cool-off and access-window gate as\r\nthe relay shares, and never once the session is terminal or zeroized.",
"tags": [
"EmergencyAccessRequest"
]
}
},
"/api/v1/escrow/requests/{id}/share-submissions": {
"get": {
"operationId": "EmergencyAccessRequest_GetShareSubmissions",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"accessExpiresAt": "2026-01-01T00:00:00.0000000+00:00",
"earliestUnlockAt": "2026-01-01T00:00:00.0000000+00:00",
"requestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": "string",
"submissions": []
},
"schema": {
"$ref": "#/components/schemas/EscrowShareSubmissionsResponse"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Not Found"
},
"409": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Conflict"
}
},
"summary": "Returns the collected relay-share ciphertexts for a reconstruction\r\nrequest (CC-061, FR-01.037 / SR-5). Only the requester may pull, and\r\nonly after the FR-01.033 cool-off window has elapsed.",
"tags": [
"EmergencyAccessRequest"
]
}
},
"/api/v1/escrow/requests/{id}/submit-share": {
"post": {
"operationId": "EmergencyAccessRequest_PostRewrappedShare",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "localOnly",
"schema": {
"type": "boolean"
}
}
],
"requestBody": {
"content": {
"application/*+json": {
"example": {
"holderId": "string",
"rewrapCiphertextBase64": "string",
"shareIndex": 0
},
"schema": {
"$ref": "#/components/schemas/PostRewrappedEscrowShareRequest"
}
},
"application/json": {
"example": {
"holderId": "string",
"rewrapCiphertextBase64": "string",
"shareIndex": 0
},
"schema": {
"$ref": "#/components/schemas/PostRewrappedEscrowShareRequest"
}
},
"text/json": {
"example": {
"holderId": "string",
"rewrapCiphertextBase64": "string",
"shareIndex": 0
},
"schema": {
"$ref": "#/components/schemas/PostRewrappedEscrowShareRequest"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"accessExpiresAt": "2026-01-01T00:00:00.0000000+00:00",
"accessExtensionChallengeNonce": "string",
"accessExtensionCount": 0,
"accessWindowCeiling": "2026-01-01T00:00:00.0000000+00:00",
"approvalChallengeNonce": "string",
"approvalCount": 0,
"earliestUnlockAt": "2026-01-01T00:00:00.0000000+00:00",
"enrolmentId": "string",
"expiresAt": "2026-01-01T00:00:00.0000000+00:00",
"requestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"shareSubmissionCount": 0,
"status": "string",
"updatedAt": "2026-01-01T00:00:00.0000000+00:00",
"zeroizationSignalledAt": "2026-01-01T00:00:00.0000000+00:00"
},
"schema": {
"$ref": "#/components/schemas/EscrowReconstructionLifecycleResponse"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Not Found"
},
"409": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Conflict"
}
},
"summary": "Accepts an RSA-OAEP re-wrap of a decrypted Shamir share (CC-061,\r\nFR-01.037 / SR-5). The server stores the ciphertext only; the\r\nrequester pulls the collection via\r\n`GET /requests/{id}/share-submissions` once the cool-off window\r\nhas elapsed.",
"tags": [
"EmergencyAccessRequest"
]
}
},
"/api/v1/escrow/status": {
"get": {
"operationId": "EscrowEnrolment_GetStatus",
"parameters": [
{
"in": "query",
"name": "cursor",
"schema": {
"format": "date-time",
"type": "string"
}
},
{
"in": "query",
"name": "limit",
"schema": {
"format": "int32",
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/EscrowEnrolmentStatusResponse"
},
"type": "array"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Unauthorized"
}
},
"summary": "Returns the caller's Tier E-2 enrolments (masked — SR-5 — never\r\nreturns ciphertexts). Supports keyset pagination (DAT-006) via the\r\n`cursor` query parameter: pass the `createdAt` of the\r\nlast row from the previous page to continue.",
"tags": [
"EscrowEnrolment"
]
}
},
"/api/v1/internal/device-integrity/key-custody-decisions": {
"post": {
"operationId": "InternalDeviceIntegrityDecision_Decide",
"requestBody": {
"content": {
"application/*+json": {
"example": {
"bodySha256": "string",
"deviceProof": "string",
"method": "string",
"path": "string",
"peerProof": "string",
"possessionRefusesUnverified": false,
"skipIntegrity": false,
"verifyPossession": false
},
"schema": {
"$ref": "#/components/schemas/KeyCustodyIntegrityDecisionRequest"
}
},
"application/json": {
"example": {
"bodySha256": "string",
"deviceProof": "string",
"method": "string",
"path": "string",
"peerProof": "string",
"possessionRefusesUnverified": false,
"skipIntegrity": false,
"verifyPossession": false
},
"schema": {
"$ref": "#/components/schemas/KeyCustodyIntegrityDecisionRequest"
}
},
"text/json": {
"example": {
"bodySha256": "string",
"deviceProof": "string",
"method": "string",
"path": "string",
"peerProof": "string",
"possessionRefusesUnverified": false,
"skipIntegrity": false,
"verifyPossession": false
},
"schema": {
"$ref": "#/components/schemas/KeyCustodyIntegrityDecisionRequest"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"evaluated": false,
"indeterminate": false,
"outcome": "string",
"peerOutcome": "string",
"posture": "string",
"stale": false,
"stepUpDeviceRegistrationIds": []
},
"schema": {
"$ref": "#/components/schemas/KeyCustodyIntegrityDecisionResponse"
}
}
},
"description": "The decision, or `evaluated:false`; plus `possession` when asked."
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "The request is malformed (ProblemDetails)."
},
"401": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "No valid token (or a cross-instance token without an Active federation trust)."
},
"503": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "This instance does not hold the device register either."
}
},
"summary": "Decides one custody request served on another instance, for the device the caller's token\r\nnames. 200 with `evaluated:false` when the token names no enrolled device, when integrity\r\nwas skipped, or when a refused possession ended the decision; with `possession` when it\r\nwas asked for.",
"tags": [
"InternalDeviceIntegrityDecision"
]
}
},
"/api/v1/internal/device-signing-keys/lookup": {
"post": {
"operationId": "InternalDeviceSigningKey_Lookup",
"requestBody": {
"content": {
"application/*+json": {
"example": {
"keyThumbprint": "string",
"userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"schema": {
"$ref": "#/components/schemas/DeviceSigningKeyLookupRequest"
}
},
"application/json": {
"example": {
"keyThumbprint": "string",
"userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"schema": {
"$ref": "#/components/schemas/DeviceSigningKeyLookupRequest"
}
},
"text/json": {
"example": {
"keyThumbprint": "string",
"userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"schema": {
"$ref": "#/components/schemas/DeviceSigningKeyLookupRequest"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"deviceRegistrationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"found": false,
"keyThumbprint": "string",
"publicJwk": "string"
},
"schema": {
"$ref": "#/components/schemas/DeviceSigningKeyLookupResponse"
}
}
},
"description": "The key, or the uniform miss."
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "The request is malformed (ProblemDetails)."
},
"401": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "No valid token (or a cross-instance token without an Active federation trust)."
},
"403": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "The token does not carry the reader scope."
},
"429": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "The calling service exceeded its lookup budget."
}
},
"summary": "The public JWK of the active, enrolled device key `keyThumbprint` of `userId`. 200 in\r\nboth cases: `{\"found\": true, …}`, or the uniform `{\"found\": false}`.",
"tags": [
"InternalDeviceSigningKey"
]
}
},
"/api/v1/internal/recovery/assisted/confirmation/lookup": {
"post": {
"operationId": "InternalAssistedRecoveryConfirmation_Lookup",
"requestBody": {
"content": {
"application/*+json": {
"example": {
"organizationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"recoveryTokenRef": "string"
},
"schema": {
"$ref": "#/components/schemas/AssistedRecoveryGrantConfirmationLookupRequest"
}
},
"application/json": {
"example": {
"organizationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"recoveryTokenRef": "string"
},
"schema": {
"$ref": "#/components/schemas/AssistedRecoveryGrantConfirmationLookupRequest"
}
},
"text/json": {
"example": {
"organizationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"recoveryTokenRef": "string"
},
"schema": {
"$ref": "#/components/schemas/AssistedRecoveryGrantConfirmationLookupRequest"
}
}
},
"description": "The organisation and the recovery-token reference."
},
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"anchorRef": "string",
"attestationMatchesCanonical": false,
"auditEntryHash": "string",
"auditEntryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"authorisedAt": "2026-01-01T00:00:00.0000000+00:00",
"authorisingAdminId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"confirmed": false,
"enrolmentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"grantScopeAuthoriseOnly": false,
"grantType": "string",
"noDecryptCapabilityReleased": false,
"recoveryTokenRef": "string",
"sealVerified": false,
"subjectUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"unconfirmedReason": "string",
"zkAttestation": "string"
},
"schema": {
"$ref": "#/components/schemas/AssistedRecoveryGrantConfirmationResponse"
}
}
},
"description": "The authorisation, re-derived from its sealed audit entry."
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "No organisation, or no reference."
},
"401": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "No valid bearer token."
},
"403": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "The caller is not a service principal."
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "No authorisation the named organisation issued or holds custody of carries the reference."
}
},
"summary": "EPIC 1's evidenced confirmation of one authorisation, for the organisation named.",
"tags": [
"InternalAssistedRecoveryConfirmation"
]
}
},
"/api/v1/keys/executor-bequests": {
"post": {
"operationId": "ExecutorCredentialBequest_Seal",
"requestBody": {
"content": {
"application/*+json": {
"example": {
"estateGrantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"executorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"items": [],
"triggerLabel": "string"
},
"schema": {
"$ref": "#/components/schemas/SealExecutorBequestRequest"
}
},
"application/json": {
"example": {
"estateGrantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"executorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"items": [],
"triggerLabel": "string"
},
"schema": {
"$ref": "#/components/schemas/SealExecutorBequestRequest"
}
},
"text/json": {
"example": {
"estateGrantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"executorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"items": [],
"triggerLabel": "string"
},
"schema": {
"$ref": "#/components/schemas/SealExecutorBequestRequest"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"example": {
"bequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"createdAt": "2026-01-01T00:00:00.0000000+00:00",
"executorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"itemCount": 0,
"status": "string"
},
"schema": {
"$ref": "#/components/schemas/SealExecutorBequestResponse"
}
}
},
"description": "Bequest sealed."
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Invalid request."
},
"401": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Unauthorized"
},
"409": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "A bequest already exists for this scope."
}
},
"summary": "A donor seals a bequest of credentials for their executor (debt-2026-07-07-007). Idempotent\r\nper (donor, executor, estate grant) — 409 if one already exists.",
"tags": [
"ExecutorCredentialBequest"
]
}
},
"/api/v1/keys/executor-bequests/release": {
"post": {
"operationId": "ExecutorCredentialBequest_Release",
"requestBody": {
"content": {
"application/*+json": {
"example": {
"bequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"estateGrantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"schema": {
"$ref": "#/components/schemas/ReleaseExecutorBequestRequest"
}
},
"application/json": {
"example": {
"bequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"estateGrantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"schema": {
"$ref": "#/components/schemas/ReleaseExecutorBequestRequest"
}
},
"text/json": {
"example": {
"bequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"estateGrantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"schema": {
"$ref": "#/components/schemas/ReleaseExecutorBequestRequest"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"availableItemCount": 0,
"bequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"releasedAt": "2026-01-01T00:00:00.0000000+00:00",
"status": "string"
},
"schema": {
"$ref": "#/components/schemas/ReleaseExecutorBequestResponse"
}
}
},
"description": "Released (or already released)."
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Invalid request."
},
"401": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Unauthorized"
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "No such bequest, or the grant does not authorise it."
},
"409": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "The bequest has been revoked."
}
},
"summary": "Releases a sealed bequest when the scoped legacy-release grant fires (debt-2026-07-07-007).\r\nThe `estateGrantId` must match the grant the bequest was sealed under. Idempotent.",
"tags": [
"ExecutorCredentialBequest"
]
}
},
"/api/v1/keys/executor-bequests/{bequestId}": {
"delete": {
"operationId": "ExecutorCredentialBequest_Revoke",
"parameters": [
{
"in": "path",
"name": "bequestId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Revoked (idempotent)."
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Invalid request."
},
"401": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Unauthorized"
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "No such bequest, or the caller is not its donor."
}
},
"summary": "A donor withdraws a bequest (debt-2026-07-07-007) — revoked while alive, or the estate closed.\r\nCryptographically erases every sealed envelope. Only the donor may revoke.",
"tags": [
"ExecutorCredentialBequest"
]
},
"get": {
"operationId": "ExecutorCredentialBequest_Get",
"parameters": [
{
"in": "path",
"name": "bequestId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"bequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"donorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"items": [],
"releasedAt": "2026-01-01T00:00:00.0000000+00:00",
"status": "string",
"triggerLabel": "string"
},
"schema": {
"$ref": "#/components/schemas/ExecutorBequestSummaryResponse"
}
}
},
"description": "The bequest summary (no key material)."
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Invalid request."
},
"401": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Unauthorized"
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "No such bequest for this executor."
}
},
"summary": "The authenticated executor fetches a bequest's metadata (debt-2026-07-07-007) — status and\r\nper-item labels/statuses that back the reveal surface's list. No key material. A caller who is\r\nnot the bequest's executor is answered 404 (no existence disclosure).",
"tags": [
"ExecutorCredentialBequest"
]
}
},
"/api/v1/keys/executor-bequests/{bequestId}/items/{itemId}/reveal": {
"post": {
"operationId": "ExecutorCredentialBequest_RevealItem",
"parameters": [
{
"in": "path",
"name": "bequestId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "itemId",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"authTag": "string",
"executorKeyRef": "string",
"itemId": "string",
"itemName": "string",
"iv": "string",
"revealCount": 0,
"revealedAt": "2026-01-01T00:00:00.0000000+00:00",
"sealedSecret": "string"
},
"schema": {
"$ref": "#/components/schemas/RevealedBequeathedCredentialResponse"
}
}
},
"description": "The item's sealed envelope."
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Invalid request."
},
"401": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Unauthorized"
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "No such bequest / item for this executor."
},
"409": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "The bequest has not been released yet."
}
},
"summary": "The authenticated executor reveals one bequeathed credential (debt-2026-07-07-007) — backs\r\n`onReveal`. Returns the sealed envelope for client-side reconstruction (never plaintext).",
"tags": [
"ExecutorCredentialBequest"
]
}
},
"/api/v1/keys/executor-bequests/{bequestId}/reveal-all": {
"post": {
"operationId": "ExecutorCredentialBequest_RevealAll",
"parameters": [
{
"in": "path",
"name": "bequestId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"bequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"items": []
},
"schema": {
"$ref": "#/components/schemas/RevealAllBequeathedCredentialsResponse"
}
}
},
"description": "The available items' sealed envelopes (may be empty)."
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Invalid request."
},
"401": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Unauthorized"
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "No such bequest for this executor."
},
"409": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "The bequest has not been released yet."
}
},
"summary": "The authenticated executor reveals every currently-available bequeathed credential\r\n(debt-2026-07-07-007) — backs `onRevealAll`. Returns each item's sealed envelope for\r\nclient-side reconstruction (never plaintext).",
"tags": [
"ExecutorCredentialBequest"
]
}
},
"/api/v1/keys/merge-rewrap/pending": {
"get": {
"operationId": "MergeRewrap_GetPending",
"parameters": [
{
"in": "query",
"name": "take",
"schema": {
"default": 20,
"format": "int32",
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"tasks": []
},
"schema": {
"$ref": "#/components/schemas/PendingMergeRewrapTasksResponse"
}
}
},
"description": "Open tasks, oldest first."
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Unauthorized"
}
},
"summary": "The re-wrap work the calling member's device should pick up on unlock. This read is what\r\nmakes an adjudicated merge's key work schedulable rather than session-bound.",
"tags": [
"MergeRewrap"
]
}
},
"/api/v1/keys/merge-rewrap/sessions": {
"post": {
"operationId": "MergeRewrap_Open",
"requestBody": {
"content": {
"application/*+json": {
"example": {
"caseReference": "string",
"mergeSessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"retiringUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"survivingUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"totalItems": 0,
"workWindowDays": 0
},
"schema": {
"$ref": "#/components/schemas/OpenMergeRewrapTaskRequest"
}
},
"application/json": {
"example": {
"caseReference": "string",
"mergeSessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"retiringUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"survivingUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"totalItems": 0,
"workWindowDays": 0
},
"schema": {
"$ref": "#/components/schemas/OpenMergeRewrapTaskRequest"
}
},
"text/json": {
"example": {
"caseReference": "string",
"mergeSessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"retiringUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"survivingUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"totalItems": 0,
"workWindowDays": 0
},
"schema": {
"$ref": "#/components/schemas/OpenMergeRewrapTaskRequest"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"example": {
"cancellationReason": "string",
"caseReference": "string",
"checkpointData": "string",
"claimedByDeviceId": "string",
"completedAt": "2026-01-01T00:00:00.0000000+00:00",
"expiresAt": "2026-01-01T00:00:00.0000000+00:00",
"handoverAlgorithm": "string",
"handoverEnvelope": "string",
"handoverPosted": false,
"leaseExpiresAt": "2026-01-01T00:00:00.0000000+00:00",
"mergeSessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"remainingItems": 0,
"retiringUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"rewrappedItems": 0,
"status": "string",
"survivingUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"survivorKeyRef": "string",
"taskId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"totalItems": 0
},
"schema": {
"$ref": "#/components/schemas/MergeRewrapTaskResponse"
}
}
},
"description": "Task opened."
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Invalid request."
},
"401": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Forbidden"
},
"409": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "A task already exists for this merge session."
}
},
"summary": "Opens the re-wrap task for an approved merge. Idempotent per merge session — a retried\r\napproval is answered 409 rather than forking the work in two.",
"tags": [
"MergeRewrap"
]
}
},
"/api/v1/keys/merge-rewrap/sessions/{mergeSessionId}": {
"get": {
"operationId": "MergeRewrap_Get",
"parameters": [
{
"in": "path",
"name": "mergeSessionId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"cancellationReason": "string",
"caseReference": "string",
"checkpointData": "string",
"claimedByDeviceId": "string",
"completedAt": "2026-01-01T00:00:00.0000000+00:00",
"expiresAt": "2026-01-01T00:00:00.0000000+00:00",
"handoverAlgorithm": "string",
"handoverEnvelope": "string",
"handoverPosted": false,
"leaseExpiresAt": "2026-01-01T00:00:00.0000000+00:00",
"mergeSessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"remainingItems": 0,
"retiringUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"rewrappedItems": 0,
"status": "string",
"survivingUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"survivorKeyRef": "string",
"taskId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"totalItems": 0
},
"schema": {
"$ref": "#/components/schemas/MergeRewrapTaskResponse"
}
}
},
"description": "Task state."
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Unauthorized"
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "No task for this merge session, or the caller is on neither side."
}
},
"summary": "Reads one task as a member of the merge (survivor sees the material it must unwrap).",
"tags": [
"MergeRewrap"
]
}
},
"/api/v1/keys/merge-rewrap/sessions/{mergeSessionId}/cancel": {
"post": {
"operationId": "MergeRewrap_Cancel",
"parameters": [
{
"in": "path",
"name": "mergeSessionId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/*+json": {
"example": {
"reason": "string"
},
"schema": {
"$ref": "#/components/schemas/CancelMergeRewrapRequestBody"
}
},
"application/json": {
"example": {
"reason": "string"
},
"schema": {
"$ref": "#/components/schemas/CancelMergeRewrapRequestBody"
}
},
"text/json": {
"example": {
"reason": "string"
},
"schema": {
"$ref": "#/components/schemas/CancelMergeRewrapRequestBody"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"cancellationReason": "string",
"caseReference": "string",
"checkpointData": "string",
"claimedByDeviceId": "string",
"completedAt": "2026-01-01T00:00:00.0000000+00:00",
"expiresAt": "2026-01-01T00:00:00.0000000+00:00",
"handoverAlgorithm": "string",
"handoverEnvelope": "string",
"handoverPosted": false,
"leaseExpiresAt": "2026-01-01T00:00:00.0000000+00:00",
"mergeSessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"remainingItems": 0,
"retiringUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"rewrappedItems": 0,
"status": "string",
"survivingUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"survivorKeyRef": "string",
"taskId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"totalItems": 0
},
"schema": {
"$ref": "#/components/schemas/MergeRewrapTaskResponse"
}
}
},
"description": "Cancelled."
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "No task for this merge session."
},
"409": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "The task is already terminal."
}
},
"summary": "Cancels the task — the merge was refused, withdrawn or abandoned.",
"tags": [
"MergeRewrap"
]
}
},
"/api/v1/keys/merge-rewrap/sessions/{mergeSessionId}/checkpoint": {
"post": {
"operationId": "MergeRewrap_Checkpoint",
"parameters": [
{
"in": "path",
"name": "mergeSessionId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/*+json": {
"example": {
"checkpointData": "string",
"deviceId": "string",
"rewrappedItems": 0
},
"schema": {
"$ref": "#/components/schemas/CheckpointMergeRewrapRequest"
}
},
"application/json": {
"example": {
"checkpointData": "string",
"deviceId": "string",
"rewrappedItems": 0
},
"schema": {
"$ref": "#/components/schemas/CheckpointMergeRewrapRequest"
}
},
"text/json": {
"example": {
"checkpointData": "string",
"deviceId": "string",
"rewrappedItems": 0
},
"schema": {
"$ref": "#/components/schemas/CheckpointMergeRewrapRequest"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"cancellationReason": "string",
"caseReference": "string",
"checkpointData": "string",
"claimedByDeviceId": "string",
"completedAt": "2026-01-01T00:00:00.0000000+00:00",
"expiresAt": "2026-01-01T00:00:00.0000000+00:00",
"handoverAlgorithm": "string",
"handoverEnvelope": "string",
"handoverPosted": false,
"leaseExpiresAt": "2026-01-01T00:00:00.0000000+00:00",
"mergeSessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"remainingItems": 0,
"retiringUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"rewrappedItems": 0,
"status": "string",
"survivingUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"survivorKeyRef": "string",
"taskId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"totalItems": 0
},
"schema": {
"$ref": "#/components/schemas/MergeRewrapTaskResponse"
}
}
},
"description": "Checkpoint recorded."
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Progress went backwards or exceeded the enumerated total."
},
"401": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Not Found"
},
"409": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "The lease has expired — re-claim to continue."
}
},
"summary": "Records a resume point and renews the lease.",
"tags": [
"MergeRewrap"
]
}
},
"/api/v1/keys/merge-rewrap/sessions/{mergeSessionId}/claim": {
"post": {
"operationId": "MergeRewrap_Claim",
"parameters": [
{
"in": "path",
"name": "mergeSessionId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/*+json": {
"example": {
"deviceId": "string",
"leaseMinutes": 0
},
"schema": {
"$ref": "#/components/schemas/ClaimMergeRewrapRequest"
}
},
"application/json": {
"example": {
"deviceId": "string",
"leaseMinutes": 0
},
"schema": {
"$ref": "#/components/schemas/ClaimMergeRewrapRequest"
}
},
"text/json": {
"example": {
"deviceId": "string",
"leaseMinutes": 0
},
"schema": {
"$ref": "#/components/schemas/ClaimMergeRewrapRequest"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"cancellationReason": "string",
"caseReference": "string",
"checkpointData": "string",
"claimedByDeviceId": "string",
"completedAt": "2026-01-01T00:00:00.0000000+00:00",
"expiresAt": "2026-01-01T00:00:00.0000000+00:00",
"handoverAlgorithm": "string",
"handoverEnvelope": "string",
"handoverPosted": false,
"leaseExpiresAt": "2026-01-01T00:00:00.0000000+00:00",
"mergeSessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"remainingItems": 0,
"retiringUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"rewrappedItems": 0,
"status": "string",
"survivingUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"survivorKeyRef": "string",
"taskId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"totalItems": 0
},
"schema": {
"$ref": "#/components/schemas/MergeRewrapTaskResponse"
}
}
},
"description": "Lease held; the response carries the envelope and resume checkpoint."
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "No task for this merge session, or the caller is on neither side."
},
"409": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Handover not posted, another device holds a live lease, or the task has lapsed."
}
},
"summary": "Takes (or renews) the work lease for one of the survivor's devices. A lapsed lease is\r\nclaimable by another device, so a member whose phone died is not locked out of their own\r\nmerge by their own dead phone.",
"tags": [
"MergeRewrap"
]
}
},
"/api/v1/keys/merge-rewrap/sessions/{mergeSessionId}/complete": {
"post": {
"operationId": "MergeRewrap_Complete",
"parameters": [
{
"in": "path",
"name": "mergeSessionId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/*+json": {
"example": {
"deviceId": "string"
},
"schema": {
"$ref": "#/components/schemas/CompleteMergeRewrapRequest"
}
},
"application/json": {
"example": {
"deviceId": "string"
},
"schema": {
"$ref": "#/components/schemas/CompleteMergeRewrapRequest"
}
},
"text/json": {
"example": {
"deviceId": "string"
},
"schema": {
"$ref": "#/components/schemas/CompleteMergeRewrapRequest"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"cancellationReason": "string",
"caseReference": "string",
"checkpointData": "string",
"claimedByDeviceId": "string",
"completedAt": "2026-01-01T00:00:00.0000000+00:00",
"expiresAt": "2026-01-01T00:00:00.0000000+00:00",
"handoverAlgorithm": "string",
"handoverEnvelope": "string",
"handoverPosted": false,
"leaseExpiresAt": "2026-01-01T00:00:00.0000000+00:00",
"mergeSessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"remainingItems": 0,
"retiringUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"rewrappedItems": 0,
"status": "string",
"survivingUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"survivorKeyRef": "string",
"taskId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"totalItems": 0
},
"schema": {
"$ref": "#/components/schemas/MergeRewrapTaskResponse"
}
}
},
"description": "Complete; the completion event is enqueued for the adjudicating service."
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Not Found"
},
"409": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Items remain un-re-wrapped, or the lease has expired."
}
},
"summary": "The leasing device reports the re-wrap finished. Refused while items remain — a partial\r\nre-wrap must not release the adjudication's key-rewrap hold.",
"tags": [
"MergeRewrap"
]
}
},
"/api/v1/keys/merge-rewrap/sessions/{mergeSessionId}/handover": {
"post": {
"operationId": "MergeRewrap_PostHandover",
"parameters": [
{
"in": "path",
"name": "mergeSessionId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/*+json": {
"example": {
"algorithm": "string",
"handoverEnvelope": "string",
"survivorKeyRef": "string"
},
"schema": {
"$ref": "#/components/schemas/PostMergeHandoverRequest"
}
},
"application/json": {
"example": {
"algorithm": "string",
"handoverEnvelope": "string",
"survivorKeyRef": "string"
},
"schema": {
"$ref": "#/components/schemas/PostMergeHandoverRequest"
}
},
"text/json": {
"example": {
"algorithm": "string",
"handoverEnvelope": "string",
"survivorKeyRef": "string"
},
"schema": {
"$ref": "#/components/schemas/PostMergeHandoverRequest"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"cancellationReason": "string",
"caseReference": "string",
"checkpointData": "string",
"claimedByDeviceId": "string",
"completedAt": "2026-01-01T00:00:00.0000000+00:00",
"expiresAt": "2026-01-01T00:00:00.0000000+00:00",
"handoverAlgorithm": "string",
"handoverEnvelope": "string",
"handoverPosted": false,
"leaseExpiresAt": "2026-01-01T00:00:00.0000000+00:00",
"mergeSessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"remainingItems": 0,
"retiringUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"rewrappedItems": 0,
"status": "string",
"survivingUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"survivorKeyRef": "string",
"taskId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"totalItems": 0
},
"schema": {
"$ref": "#/components/schemas/MergeRewrapTaskResponse"
}
}
},
"description": "Handover parked; the task is now workable."
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Malformed envelope (must be base64url, within the cap)."
},
"401": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Unauthorized"
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "No task for this merge session, or the caller is on neither side."
},
"409": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "A handover has already been posted, or the task has lapsed."
}
},
"summary": "Parks the retiring account's UMK wrapped to the surviving member's public key, so the\r\nsurvivor's device can unwrap the retiring per-item DEKs days later. Posted by whichever\r\nof the two identities' devices holds the retiring key material.",
"tags": [
"MergeRewrap"
]
}
},
"/api/v1/keys/merge-rewrap/sessions/{mergeSessionId}/release": {
"post": {
"operationId": "MergeRewrap_Release",
"parameters": [
{
"in": "path",
"name": "mergeSessionId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/*+json": {
"example": {
"deviceId": "string",
"reason": "string"
},
"schema": {
"$ref": "#/components/schemas/ReleaseMergeRewrapRequest"
}
},
"application/json": {
"example": {
"deviceId": "string",
"reason": "string"
},
"schema": {
"$ref": "#/components/schemas/ReleaseMergeRewrapRequest"
}
},
"text/json": {
"example": {
"deviceId": "string",
"reason": "string"
},
"schema": {
"$ref": "#/components/schemas/ReleaseMergeRewrapRequest"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"cancellationReason": "string",
"caseReference": "string",
"checkpointData": "string",
"claimedByDeviceId": "string",
"completedAt": "2026-01-01T00:00:00.0000000+00:00",
"expiresAt": "2026-01-01T00:00:00.0000000+00:00",
"handoverAlgorithm": "string",
"handoverEnvelope": "string",
"handoverPosted": false,
"leaseExpiresAt": "2026-01-01T00:00:00.0000000+00:00",
"mergeSessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"remainingItems": 0,
"retiringUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"rewrappedItems": 0,
"status": "string",
"survivingUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"survivorKeyRef": "string",
"taskId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"totalItems": 0
},
"schema": {
"$ref": "#/components/schemas/MergeRewrapTaskResponse"
}
}
},
"description": "Lease released; the task is claimable again."
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Not Found"
},
"409": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Conflict"
}
},
"summary": "The leasing device gives the task back without completing. Progress and checkpoint are\r\nkept so the next device resumes rather than restarts.",
"tags": [
"MergeRewrap"
]
}
},
"/api/v1/keys/merge-rewrap/sessions/{mergeSessionId}/status": {
"get": {
"operationId": "MergeRewrap_GetStatus",
"parameters": [
{
"in": "path",
"name": "mergeSessionId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"cancellationReason": "string",
"caseReference": "string",
"checkpointData": "string",
"claimedByDeviceId": "string",
"completedAt": "2026-01-01T00:00:00.0000000+00:00",
"expiresAt": "2026-01-01T00:00:00.0000000+00:00",
"handoverAlgorithm": "string",
"handoverEnvelope": "string",
"handoverPosted": false,
"leaseExpiresAt": "2026-01-01T00:00:00.0000000+00:00",
"mergeSessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"remainingItems": 0,
"retiringUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"rewrappedItems": 0,
"status": "string",
"survivingUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"survivorKeyRef": "string",
"taskId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"totalItems": 0
},
"schema": {
"$ref": "#/components/schemas/MergeRewrapTaskResponse"
}
}
},
"description": "Task state, without key material."
},
"401": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "No task for this merge session."
}
},
"summary": "The adjudicating service's release gate: is the re-wrap done? Deliberately returns no\r\nkey material — a staff surface can see that a merge is held without ever holding the\r\nenvelope. This is the poll-side twin of the completion event, so the release gate never\r\ndepends on a single message delivery.",
"tags": [
"MergeRewrap"
]
}
},
"/api/v1/keys/password-change-saga/status": {
"get": {
"operationId": "PasswordChangeSaga_GetStatus",
"parameters": [
{
"description": "The account whose would-be-failing auth attempt is being disambiguated.",
"in": "query",
"name": "userId",
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"isOpen": false,
"retryAfterSeconds": 0
},
"schema": {
"$ref": "#/components/schemas/PasswordChangeSagaStatusResponse"
}
}
},
"description": "Saga state returned (open or not)."
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Missing or malformed `userId`."
}
},
"summary": "Consults the authoritative `password_change_sagas` record for a user\r\n(End-B producer, FR-01.073/078). Returns `{ isOpen, retryAfterSeconds }`.",
"tags": [
"PasswordChangeSaga"
]
}
},
"/api/v1/keys/private-envelope": {
"get": {
"operationId": "UserPrivateKeyEnvelope_Get",
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"algo": "string",
"ciphertext": "string",
"iv": "string",
"keyEpoch": 0
},
"schema": {
"$ref": "#/components/schemas/UserPrivateKeyEnvelopeResponse"
}
}
},
"description": "Envelope returned."
},
"401": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "No authenticated identity present."
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "No envelope exists for this account."
},
"429": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Envelope-fetch rate limit exceeded."
}
},
"summary": "Fetches the caller's wrapped private-key envelope so another device can\r\nre-derive the UMK and unwrap the account keyset locally. Rate-limited\r\n(default 5/hour/account) mirroring the wrapped-UMK envelope fetch throttle\r\n(FR-01.074-style — defends online guessing/harvesting of a stolen envelope).",
"tags": [
"UserPrivateKeyEnvelope"
]
},
"put": {
"operationId": "UserPrivateKeyEnvelope_Put",
"requestBody": {
"content": {
"application/*+json": {
"example": {
"algo": "string",
"ciphertext": "string",
"iv": "string",
"keyEpoch": 0
},
"schema": {
"$ref": "#/components/schemas/UpsertUserPrivateKeyEnvelopeRequest"
}
},
"application/json": {
"example": {
"algo": "string",
"ciphertext": "string",
"iv": "string",
"keyEpoch": 0
},
"schema": {
"$ref": "#/components/schemas/UpsertUserPrivateKeyEnvelopeRequest"
}
},
"text/json": {
"example": {
"algo": "string",
"ciphertext": "string",
"iv": "string",
"keyEpoch": 0
},
"schema": {
"$ref": "#/components/schemas/UpsertUserPrivateKeyEnvelopeRequest"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"algo": "string",
"ciphertext": "string",
"iv": "string",
"keyEpoch": 0
},
"schema": {
"$ref": "#/components/schemas/UserPrivateKeyEnvelopeResponse"
}
}
},
"description": "Envelope upserted."
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Invalid request — no authenticated identity, or malformed base64 ciphertext/iv."
},
"401": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "No authenticated identity present."
},
"409": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "A newer epoch is already stored for this account (stale epoch)."
}
},
"summary": "Mints or replaces the caller's wrapped private-key envelope. Create-vs-replace\r\nis decided server-side by whether the caller already has a row; a replace\r\nsubmitted with a `keyEpoch` older than the stored epoch is rejected 409\r\n(concurrent-mint convergence guard — the caller lost a race against a newer\r\nmint and must retry against the current epoch).",
"tags": [
"UserPrivateKeyEnvelope"
]
}
},
"/api/v1/keys/shared-credentials/wraps": {
"delete": {
"operationId": "SharedCredentialWrap_Revoke",
"requestBody": {
"content": {
"application/*+json": {
"example": {
"householdId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"sharedCredentialId": "string"
},
"schema": {
"$ref": "#/components/schemas/RevokeSharedCredentialWrapRequest"
}
},
"application/json": {
"example": {
"householdId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"sharedCredentialId": "string"
},
"schema": {
"$ref": "#/components/schemas/RevokeSharedCredentialWrapRequest"
}
},
"text/json": {
"example": {
"householdId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"sharedCredentialId": "string"
},
"schema": {
"$ref": "#/components/schemas/RevokeSharedCredentialWrapRequest"
}
}
}
},
"responses": {
"204": {
"description": "Revoked (idempotent)."
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Invalid request."
},
"401": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Unauthorized"
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "No wrap exists for this credential, or the caller is not its owner."
}
},
"summary": "Withdraws a household's shared credential from sharing (FR-01.097) — deleted, or the last\r\ngrantee departed. Only the owner may revoke. Cryptographically erases every recipient wrap.",
"tags": [
"SharedCredentialWrap"
]
},
"post": {
"operationId": "SharedCredentialWrap_Wrap",
"requestBody": {
"content": {
"application/*+json": {
"example": {
"householdId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"recipients": [],
"sharedCredentialId": "string"
},
"schema": {
"$ref": "#/components/schemas/WrapSharedCredentialRequest"
}
},
"application/json": {
"example": {
"householdId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"recipients": [],
"sharedCredentialId": "string"
},
"schema": {
"$ref": "#/components/schemas/WrapSharedCredentialRequest"
}
},
"text/json": {
"example": {
"householdId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"recipients": [],
"sharedCredentialId": "string"
},
"schema": {
"$ref": "#/components/schemas/WrapSharedCredentialRequest"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"example": {
"createdAt": "2026-01-01T00:00:00.0000000+00:00",
"generation": 0,
"recipientCount": 0,
"wrapId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"schema": {
"$ref": "#/components/schemas/WrapSharedCredentialResponse"
}
}
},
"description": "Wrap created."
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Invalid request."
},
"401": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Unauthorized"
},
"409": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "A wrap already exists for this credential (re-wrap instead)."
}
},
"summary": "Creates the first-generation multi-recipient wrap for a household's shared credential\r\n(FR-01.097). Idempotent per (household, credential) — 409 if one already exists.",
"tags": [
"SharedCredentialWrap"
]
},
"put": {
"operationId": "SharedCredentialWrap_Rewrap",
"requestBody": {
"content": {
"application/*+json": {
"example": {
"householdId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"recipients": [],
"sharedCredentialId": "string"
},
"schema": {
"$ref": "#/components/schemas/RewrapSharedCredentialRequest"
}
},
"application/json": {
"example": {
"householdId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"recipients": [],
"sharedCredentialId": "string"
},
"schema": {
"$ref": "#/components/schemas/RewrapSharedCredentialRequest"
}
},
"text/json": {
"example": {
"householdId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"recipients": [],
"sharedCredentialId": "string"
},
"schema": {
"$ref": "#/components/schemas/RewrapSharedCredentialRequest"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"generation": 0,
"recipientCount": 0,
"updatedAt": "2026-01-01T00:00:00.0000000+00:00"
},
"schema": {
"$ref": "#/components/schemas/RewrapSharedCredentialResponse"
}
}
},
"description": "Re-wrap committed; generation bumped."
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Invalid request."
},
"401": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Unauthorized"
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "No wrap exists for this credential, or the caller is not its owner."
},
"409": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "The wrap has been revoked."
}
},
"summary": "Re-wraps a household's shared credential for the remaining granted set on rotation or\r\nmember departure (FR-01.097). Only the owner may re-wrap.",
"tags": [
"SharedCredentialWrap"
]
}
},
"/api/v1/keys/shared-credentials/wraps/mine": {
"get": {
"operationId": "SharedCredentialWrap_GetMine",
"parameters": [
{
"in": "query",
"name": "householdId",
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "sharedCredentialId",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"authTag": "string",
"generation": 0,
"iv": "string",
"recipientKeyRef": "string",
"sharedCredentialId": "string",
"wrappedSecret": "string"
},
"schema": {
"$ref": "#/components/schemas/SharedCredentialWrapForRecipientResponse"
}
}
},
"description": "The caller's wrapped envelope."
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Invalid request."
},
"401": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Unauthorized"
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "The caller is not a current grantee of this credential."
}
},
"summary": "Fetches the caller's own current-generation wrapped copy of a shared credential's secret\r\n(FR-01.097), to unwrap locally. A non-grantee is answered 404 (no existence disclosure).",
"tags": [
"SharedCredentialWrap"
]
}
},
"/api/v1/keys/wrapped-umk": {
"get": {
"operationId": "WrappedUmk_Get",
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"currentGeneration": "string",
"envelopes": []
},
"schema": {
"$ref": "#/components/schemas/GetWrappedUmkEnvelopeResponse"
}
}
},
"description": "Envelope set returned."
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "No envelope exists for this account."
},
"429": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Envelope-fetch rate limit exceeded (FR-01.074)."
},
"500": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Internal Server Error"
}
},
"summary": "Fetches the wrapped-UMK envelope set so a fresh device can derive the KEK\r\nand unwrap the UMK with the password alone (FR-01.074). Returns the current\r\nenvelope plus any retiring prior-generation envelope during a rotation\r\ndual-key window. Rate-limited (default 5/hour/account) to defend online\r\nguessing of a stolen envelope; a 429 increments the throttled-fetch count\r\nand raises the FR-01.N66.011 anomaly notification.",
"tags": [
"WrappedUmk"
]
},
"post": {
"operationId": "WrappedUmk_Create",
"requestBody": {
"content": {
"application/*+json": {
"example": {
"authTag": "string",
"iv": "string",
"passkeyBindingToken": "string",
"passkeyCredentialId": "string",
"wrappedUmk": "string"
},
"schema": {
"$ref": "#/components/schemas/CreateWrappedUmkEnvelopeRequest"
}
},
"application/json": {
"example": {
"authTag": "string",
"iv": "string",
"passkeyBindingToken": "string",
"passkeyCredentialId": "string",
"wrappedUmk": "string"
},
"schema": {
"$ref": "#/components/schemas/CreateWrappedUmkEnvelopeRequest"
}
},
"text/json": {
"example": {
"authTag": "string",
"iv": "string",
"passkeyBindingToken": "string",
"passkeyCredentialId": "string",
"wrappedUmk": "string"
},
"schema": {
"$ref": "#/components/schemas/CreateWrappedUmkEnvelopeRequest"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"example": {
"createdAt": "2026-01-01T00:00:00.0000000+00:00",
"version": 0
},
"schema": {
"$ref": "#/components/schemas/CreateWrappedUmkEnvelopeResponse"
}
}
},
"description": "Envelope created."
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Invalid request."
},
"409": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "An envelope already exists for this account."
},
"500": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Internal Server Error"
}
},
"summary": "Creates the wrapped-UMK envelope at registration (FR-01.075). Idempotent\r\nper account — returns 409 if an envelope already exists (use `PUT` to\r\nre-wrap). Atomically seeds the genesis `key_generations` row.",
"tags": [
"WrappedUmk"
]
},
"put": {
"operationId": "WrappedUmk_Rewrap",
"requestBody": {
"content": {
"application/*+json": {
"example": {
"authTag": "string",
"iv": "string",
"postRecoveryBypass": false,
"wrappedUmk": "string"
},
"schema": {
"$ref": "#/components/schemas/RewrapWrappedUmkEnvelopeRequest"
}
},
"application/json": {
"example": {
"authTag": "string",
"iv": "string",
"postRecoveryBypass": false,
"wrappedUmk": "string"
},
"schema": {
"$ref": "#/components/schemas/RewrapWrappedUmkEnvelopeRequest"
}
},
"text/json": {
"example": {
"authTag": "string",
"iv": "string",
"postRecoveryBypass": false,
"wrappedUmk": "string"
},
"schema": {
"$ref": "#/components/schemas/RewrapWrappedUmkEnvelopeRequest"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"updatedAt": "2026-01-01T00:00:00.0000000+00:00",
"version": 0
},
"schema": {
"$ref": "#/components/schemas/RewrapWrappedUmkEnvelopeResponse"
}
}
},
"description": "Envelope re-wrapped."
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Invalid request or re-auth proof missing."
},
"401": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "EPIC 9 step-up assertion required."
},
"403": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Re-auth proof invalid."
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "No envelope exists for this account."
},
"409": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "A conflicting keylifecycle operation is in progress."
}
},
"summary": "Re-wraps the same UMK under a freshly-derived KEK after a password change\r\nor PBKDF2-iteration upgrade (FR-01.073). Gated behind a re-auth proof; the\r\nUMK / key hierarchy / stored ciphertext are untouched and the generation\r\ndoes not advance.",
"tags": [
"WrappedUmk"
]
}
},
"/api/v1/keys/wrapped-umk/duress-envelope": {
"post": {
"description": "\n\r\n The client derives a KEK from the owner's alternate (\"duress\") passphrase,\r\n wraps a freshly-generated DECOY UMK under it, re-wraps the file keys of the\r\n documents the owner curated, and seals that list under the decoy UMK. Only\r\n opaque ciphertext reaches here: the server never sees the alternate passphrase,\r\n the decoy UMK, or which documents were chosen.\r\n \r\n\n\r\n Unlike `POST` (the registration create) this does not 409 against\r\n the account's existing primary envelope — a decoy occupies a different slot.\r\n The single-current-envelope guarantee is preserved per slot by\r\n `unq_wrapped_umk_current` keyed on `(user_id, kind)`, so a second\r\n envelope of the SAME kind still conflicts exactly as before. Re-enrolling under\r\n a new alternate passphrase re-wraps the existing decoy in place.\r\n ",
"operationId": "WrappedUmk_EnrolDuressEnvelope",
"requestBody": {
"content": {
"application/*+json": {
"example": {
"authTag": "string",
"behaviourAcknowledgementVersion": "string",
"iv": "string",
"manifestAuthTag": "string",
"manifestIv": "string",
"sealedManifest": "string",
"wrappedUmk": "string"
},
"schema": {
"$ref": "#/components/schemas/EnrolDuressEnvelopeRequest"
}
},
"application/json": {
"example": {
"authTag": "string",
"behaviourAcknowledgementVersion": "string",
"iv": "string",
"manifestAuthTag": "string",
"manifestIv": "string",
"sealedManifest": "string",
"wrappedUmk": "string"
},
"schema": {
"$ref": "#/components/schemas/EnrolDuressEnvelopeRequest"
}
},
"text/json": {
"example": {
"authTag": "string",
"behaviourAcknowledgementVersion": "string",
"iv": "string",
"manifestAuthTag": "string",
"manifestIv": "string",
"sealedManifest": "string",
"wrappedUmk": "string"
},
"schema": {
"$ref": "#/components/schemas/EnrolDuressEnvelopeRequest"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"example": {
"createdAt": "2026-01-01T00:00:00.0000000+00:00",
"version": 0
},
"schema": {
"$ref": "#/components/schemas/CreateWrappedUmkEnvelopeResponse"
}
}
},
"description": "Decoy envelope and sealed manifest enrolled (or re-wrapped)."
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Invalid request or unresolved user identity."
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "The account has no primary envelope to enrol a decoy against."
},
"409": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "A concurrent enrolment won the race for this slot."
},
"500": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Internal Server Error"
}
},
"summary": "Enrols the account's decoy vault-unlock envelope plus the\r\nsealed manifest of the curated subset it exposes (journey\r\n`duress-passphrase-silent-alarm-and-decoy-unlock`).",
"tags": [
"WrappedUmk"
]
}
},
"/api/v1/keys/wrapped-umk/generation": {
"get": {
"operationId": "KeyGeneration_GetCurrent",
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"currentGeneration": "string",
"pendingRotationSessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"schema": {
"$ref": "#/components/schemas/CurrentKeyGenerationResponse"
}
}
},
"description": "The current generation, or `null` when the account has no envelope."
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "The token carries no user identity."
}
},
"summary": "The caller's current key generation.",
"tags": [
"KeyGeneration"
]
}
},
"/api/v1/keys/wrapped-umk/majority-transition-rekey": {
"post": {
"description": "Authorised by a one-shot `purpose=majority-transition-rekey` token minted by\r\nthe EPIC 30/9 CC-070 orchestration after it verified majority + identity — not a\r\ncurrent-envelope re-auth proof (the first-time-claiming adult cannot produce one)\r\nand never a live guardian (FR-30.011 makes the guardian non-essential). Mirrors\r\nthe FR-01.092 `purpose=envelope-provisioning` registration gate. Zero-knowledge:\r\nonly the re-wrapped ciphertext + KEK parameters reach the server.",
"operationId": "WrappedUmk_RekeyMajorityTransition",
"requestBody": {
"content": {
"application/*+json": {
"example": {
"authTag": "string",
"iv": "string",
"transitionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"wrappedUmk": "string"
},
"schema": {
"$ref": "#/components/schemas/RekeyMajorityTransitionRequest"
}
},
"application/json": {
"example": {
"authTag": "string",
"iv": "string",
"transitionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"wrappedUmk": "string"
},
"schema": {
"$ref": "#/components/schemas/RekeyMajorityTransitionRequest"
}
},
"text/json": {
"example": {
"authTag": "string",
"iv": "string",
"transitionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"wrappedUmk": "string"
},
"schema": {
"$ref": "#/components/schemas/RekeyMajorityTransitionRequest"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"keyGeneration": "string",
"rekeyedAt": "2026-01-01T00:00:00.0000000+00:00",
"transitionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"version": 0
},
"schema": {
"$ref": "#/components/schemas/RekeyMajorityTransitionResponse"
}
}
},
"description": "Re-key committed; superseding-attestation event enqueued."
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Invalid request or unresolved user identity."
},
"403": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Missing/invalid majority-transition token (wrong purpose claim)."
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "No envelope exists for this account."
},
"409": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "A conflicting keylifecycle operation is in progress."
}
},
"summary": "Performs the offline-capable EPIC-1 re-key leg of the CC-070 minor→adult\r\nmajority transition (journey `guardian-minor-vault-to-adulthood-handover`,\r\nFR-30.011). Re-wraps the same UMK under the new adult's KEK — transferring sole\r\nkey custody and severing the guardian-pre-enrolled transition envelope — and\r\nenqueues the discrete `MinorMajorityVaultRekeyedIntegrationEvent` so EPIC 4\r\nwrites the superseding attestation the transition compliance report evidences.",
"tags": [
"WrappedUmk"
]
}
},
"/api/v1/keys/wrapped-umk/passkey": {
"get": {
"operationId": "WrappedUmk_ListPasskeyUnlockers",
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"items": []
},
"schema": {
"$ref": "#/components/schemas/ListPasskeyUnlockersResponse"
}
}
},
"description": "The passkey vault-unlockers (possibly none)."
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Unresolved user identity."
}
},
"summary": "Lists the account's passkey vault-unlockers and the device each is linked to (FR-01.049,\r\n#17493). A device removal revokes only the envelopes linked to that device, so an envelope\r\nlisted with `enrolledByDevice: null` survives every removal and is for its owner to\r\nsee and remove. Metadata only (no ciphertext or KDF input), so it is held to the default\r\nrate limit, not the FR-01.074 envelope-fetch budget.",
"tags": [
"WrappedUmk"
]
},
"post": {
"operationId": "WrappedUmk_EnrollPasskey",
"requestBody": {
"content": {
"application/*+json": {
"example": {
"authTag": "string",
"iv": "string",
"passkeyBindingToken": "string",
"passkeyCredentialId": "string",
"prfInput": "string",
"wrappedUmk": "string"
},
"schema": {
"$ref": "#/components/schemas/EnrollPasskeyEnvelopeRequest"
}
},
"application/json": {
"example": {
"authTag": "string",
"iv": "string",
"passkeyBindingToken": "string",
"passkeyCredentialId": "string",
"prfInput": "string",
"wrappedUmk": "string"
},
"schema": {
"$ref": "#/components/schemas/EnrollPasskeyEnvelopeRequest"
}
},
"text/json": {
"example": {
"authTag": "string",
"iv": "string",
"passkeyBindingToken": "string",
"passkeyCredentialId": "string",
"prfInput": "string",
"wrappedUmk": "string"
},
"schema": {
"$ref": "#/components/schemas/EnrollPasskeyEnvelopeRequest"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"example": {
"createdAt": "2026-01-01T00:00:00.0000000+00:00",
"version": 0
},
"schema": {
"$ref": "#/components/schemas/CreateWrappedUmkEnvelopeResponse"
}
}
},
"description": "Passkey envelope enrolled."
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Invalid request, or no `passkeyBindingToken` (`passkey_binding_required`)."
},
"403": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "The `passkeyBindingToken` does not show the credential is the caller's (`passkey_binding_invalid`, #8149)."
},
"409": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "A passkey envelope already exists for this credential."
},
"500": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Internal Server Error"
}
},
"summary": "Enrols an ADDITIONAL passkey vault-unlock envelope onto the authenticated\r\naccount (FR-01.058 passkey passwordless vault-unlock). The client wraps the\r\naccount's UMK under a KEK HKDF-derived from the passkey's WebAuthn-PRF output;\r\nthis stores that envelope keyed by resident credential. Unlike `POST` (the\r\nregistration create), it coexists with the account's password / other passkey\r\nenvelopes and does not seed a generation. Idempotent per credential — a re-enrol\r\nof the same credential returns 409.",
"tags": [
"WrappedUmk"
]
}
},
"/api/v1/keys/wrapped-umk/passkey/{credentialId}": {
"delete": {
"operationId": "WrappedUmk_DeletePasskey",
"parameters": [
{
"in": "path",
"name": "credentialId",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Envelope removed (or already absent)."
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Unresolved user identity."
},
"401": {
"description": "No fresh `act=recovery-settings-change` elevation (`step-up-required`, DVS-4.4c)."
}
},
"summary": "Removes the passkey vault-unlock envelope for a resident credential (FR-01.058\r\ncryptographic revocation, §5). Call this whenever the passkey itself is removed\r\nso the wrapped UMK for that credential becomes unreachable. Idempotent — a\r\nnon-existent credential envelope still returns 204.",
"tags": [
"WrappedUmk"
]
}
},
"/api/v1/keys/wrapped-umk/passkey/{credentialId}/attest": {
"post": {
"description": "Sent by the client after a successful local unwrap. The device is the one whose enrolled key\r\nverified the request's `X-Device-Proof` — never a body-supplied id (SEC-009(a)). Under\r\nthe soak's `Audit` mode an unproven request still reaches here and records nothing\r\n(`outcome: device-proof-unverified`). Not on the `wrapped-umk-fetch` budget: it\r\nreturns no key material.",
"operationId": "WrappedUmk_AttestPasskey",
"parameters": [
{
"in": "path",
"name": "credentialId",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"credentialId": "string",
"enrolledByDeviceRegistrationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"outcome": "string"
},
"schema": {
"$ref": "#/components/schemas/AttestPasskeyEnvelopeResponse"
}
}
},
"description": "What was recorded — see Essence.Core.MultiDeviceSync.Contracts.Responses.PasskeyEnvelopeAttestOutcomes."
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Unresolved user identity or an empty credential id."
},
"401": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "No verified device proof under `Enforce`."
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "No live passkey envelope for this credential on the account."
}
},
"summary": "Reports that this device has just unlocked the vault with a passkey (FR-01.049, #17609). An\r\nenvelope listed with `enrolledByDevice: null` is linked to the device that proves\r\npossession here, so removing that device revokes it; an envelope already linked keeps its link.",
"tags": [
"WrappedUmk"
]
}
},
"/api/v1/keys/wrapped-umk/password-change": {
"post": {
"operationId": "WrappedUmk_ChangePassword",
"requestBody": {
"content": {
"application/*+json": {
"example": {
"authTag": "string",
"iv": "string",
"wrappedUmk": "string"
},
"schema": {
"$ref": "#/components/schemas/ChangePasswordRequest"
}
},
"application/json": {
"example": {
"authTag": "string",
"iv": "string",
"wrappedUmk": "string"
},
"schema": {
"$ref": "#/components/schemas/ChangePasswordRequest"
}
},
"text/json": {
"example": {
"authTag": "string",
"iv": "string",
"wrappedUmk": "string"
},
"schema": {
"$ref": "#/components/schemas/ChangePasswordRequest"
}
}
}
},
"responses": {
"202": {
"content": {
"application/json": {
"example": {
"requestedAt": "2026-01-01T00:00:00.0000000+00:00",
"sagaId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": "string"
},
"schema": {
"$ref": "#/components/schemas/ChangePasswordResponse"
}
}
},
"description": "Saga opened; awaiting the EPIC 9 auth-hash swap."
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Invalid request."
},
"401": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "An EPIC 9 `act=password-change` step-up elevation is required on `X-Step-Up-Token` (FR-01.073)."
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "No envelope exists for this account."
},
"409": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "A password change (or other keylifecycle op) is already in progress."
},
"423": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Locked"
}
},
"summary": "Initiates the FR-01.078 cross-service password change. EPIC 1 (the saga\r\norchestrator) re-wraps the wrapped-UMK envelope, retains the prior version\r\nfor compensation, and asks EPIC 9 to swap the login auth-hash. Returns 202\r\nAccepted with the `saga_id`: the envelope re-wrap has committed and the\r\nsaga is in its `AwaitingAuthHashSwap` window. Distinct from the\r\nenvelope-only re-wrap (`PUT`) used by the FR-01.072(d) post-recovery path.",
"tags": [
"WrappedUmk"
]
}
},
"/api/v1/keys/wrapped-umk/recovery-phrase": {
"delete": {
"operationId": "WrappedUmk_DeleteRecoveryPhrase",
"responses": {
"204": {
"description": "Envelope removed (or already absent)."
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Unresolved user identity."
},
"423": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Locked"
}
},
"summary": "Removes the account's recovery-phrase vault-unlock envelope (D-126 — the user\r\ndisabled phrase recovery). The phrase-wrapped UMK becomes unreachable, so the\r\nphrase can no longer recover the vault. Idempotent — returns 204 when none exists.",
"tags": [
"WrappedUmk"
]
},
"get": {
"operationId": "WrappedUmk_GetRecoveryPhrase",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetRecoveryPhraseEnvelopeResponse"
}
}
},
"description": "Recovery-phrase envelope returned."
},
"403": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "A one-shot token with the wrong purpose claim."
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "No recovery-phrase envelope is enrolled (`reason=recovery_phrase_envelope_missing`)."
},
"429": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Envelope-fetch rate limit exceeded (FR-01.074)."
},
"500": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Internal Server Error"
}
},
"summary": "Fetches the account's recovery-phrase envelope (D-126 phase 2) so the client can\r\nre-derive the KEK from the phrase + stored salt and unwrap the UMK locally.\r\nAccepts an ordinary session JWT (the owner checking / rehearsing recovery), a\r\none-shot EPIC 9 token carrying `purpose=recovery-rewrap` (a\r\nforgotten-password recoverer who has just proved possession of the phrase), OR the\r\nsession a guardian recovery minted at its threshold (`purpose=recovery_session`\r\n+ `amr=recovery`, #15645) — the recovering device opens this envelope with the\r\nrecovery KEK it rebuilt from the guardians' shares. Any other purpose\r\n(envelope-provisioning, majority-transition-rekey, recovery_refresh, …) is 403.\r\nRate-limited by the same `wrapped-umk-fetch` policy as the main envelope\r\nfetch (FR-01.074) to defend online guessing of a stolen phrase envelope.",
"tags": [
"WrappedUmk"
]
},
"post": {
"description": "\n\r\n Re-enrolment replaces. A user who re-generates their phrase must be able to\r\n re-enrol, so an existing recovery-phrase envelope is soft-deleted (DAT-002) and the\r\n new one inserted in the same unit of work — this returns 201, not 409. Only a\r\n concurrent enrolment losing the unique-guard race returns 409\r\n (`reason=recovery_phrase_envelope_exists`).\r\n \r\n\n\r\n Zero-knowledge: no plaintext key material is ever received here — only ciphertext,\r\n GCM parameters and the PUBLIC random HKDF salt. The phrase, KEK and UMK never leave\r\n the device.\r\n ",
"operationId": "WrappedUmk_EnrolRecoveryPhrase",
"requestBody": {
"content": {
"application/*+json": {
"example": {
"authTag": "string",
"iv": "string",
"phraseSalt": "string",
"wrappedUmk": "string"
},
"schema": {
"$ref": "#/components/schemas/EnrolRecoveryPhraseEnvelopeRequest"
}
},
"application/json": {
"example": {
"authTag": "string",
"iv": "string",
"phraseSalt": "string",
"wrappedUmk": "string"
},
"schema": {
"$ref": "#/components/schemas/EnrolRecoveryPhraseEnvelopeRequest"
}
},
"text/json": {
"example": {
"authTag": "string",
"iv": "string",
"phraseSalt": "string",
"wrappedUmk": "string"
},
"schema": {
"$ref": "#/components/schemas/EnrolRecoveryPhraseEnvelopeRequest"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"example": {
"createdAt": "2026-01-01T00:00:00.0000000+00:00",
"version": 0
},
"schema": {
"$ref": "#/components/schemas/CreateWrappedUmkEnvelopeResponse"
}
}
},
"description": "Recovery-phrase envelope enrolled (or replaced)."
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Invalid request or unresolved user identity."
},
"401": {
"description": "No fresh `act=recovery-settings-change` elevation (`step-up-required`, DVS-4.4c)."
},
"409": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "A concurrent enrolment won the race for this user."
},
"423": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Locked"
},
"500": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Internal Server Error"
}
},
"summary": "Enrols — or REPLACES — the account's recovery-phrase vault-unlock\r\nenvelope (Decision D-126 phase 2). The client wraps the account's SAME UMK under a\r\nKEK HKDF-derived from the user's 24-word BIP39 phrase over a random salt; this\r\nstores that envelope tagged `Recovery-Phrase`. Like the passkey enrol it\r\ncoexists with the password / passkey envelopes and does not seed a generation.",
"tags": [
"WrappedUmk"
]
}
},
"/api/v1/keys/wrapped-umk/recovery-rewrap": {
"post": {
"operationId": "WrappedUmk_RecoveryRewrap",
"requestBody": {
"content": {
"application/*+json": {
"example": {
"authTag": "string",
"iv": "string",
"wrappedUmk": "string"
},
"schema": {
"$ref": "#/components/schemas/RecoveryRewrapRequest"
}
},
"application/json": {
"example": {
"authTag": "string",
"iv": "string",
"wrappedUmk": "string"
},
"schema": {
"$ref": "#/components/schemas/RecoveryRewrapRequest"
}
},
"text/json": {
"example": {
"authTag": "string",
"iv": "string",
"wrappedUmk": "string"
},
"schema": {
"$ref": "#/components/schemas/RecoveryRewrapRequest"
}
}
}
},
"responses": {
"202": {
"content": {
"application/json": {
"example": {
"recoveryEnrolmentTicket": "string",
"requestedAt": "2026-01-01T00:00:00.0000000+00:00",
"sagaId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": "string"
},
"schema": {
"$ref": "#/components/schemas/RecoveryRewrapResponse"
}
}
},
"description": "Saga opened; awaiting the EPIC 9 auth-hash swap."
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Invalid request (incl. missing `authHashUpdate`)."
},
"403": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Missing/invalid recovery-rewrap token (wrong or absent purpose claim)."
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "No password envelope exists for this account."
},
"409": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "A password change (or other keylifecycle op) is already in progress, or this guardian-recovery session has already re-wrapped once."
}
},
"summary": "Completes a D-126 forgotten-password recovery: replaces the CURRENT primary\r\npassword envelope with the same UMK re-wrapped under a NEW password and relays the\r\nnew EPIC 9 auth-hash through the FR-01.078 password-change saga — exactly as\r\n`POST .../password-change`, but WITHOUT a current-password precondition or\r\nstep-up gate. The proof is the one-shot EPIC 9 token carrying\r\n`purpose=recovery-rewrap`, minted only after the user proved possession of\r\ntheir recovery phrase — or the session a guardian recovery minted at its threshold\r\n(`purpose=recovery_session` + `amr=recovery`, FR-01.072(d), #15645), which\r\nbuys ONE re-wrap (a second since its `iat` is 409\r\n`recovery_session_rewrap_spent`). An ordinary session JWT is rejected (403). Returns 202 with\r\nthe `saga_id`: the envelope re-wrap has committed and the saga awaits the\r\nEPIC 9 auth-hash swap. The recovery-phrase envelope itself is untouched. A phrase recovery's\r\nresponse also carries the single-use `recoveryEnrolmentTicket` (#18062) that lets this\r\nbrowser enrol its signing key once after it signs in.",
"tags": [
"WrappedUmk"
]
}
},
"/api/v1/keys/wrapped-umk/registration": {
"post": {
"operationId": "WrappedUmk_ProvisionRegistration",
"requestBody": {
"content": {
"application/*+json": {
"example": {
"authTag": "string",
"iv": "string",
"wrappedUmk": "string"
},
"schema": {
"$ref": "#/components/schemas/ProvisionRegistrationEnvelopeRequest"
}
},
"application/json": {
"example": {
"authTag": "string",
"iv": "string",
"wrappedUmk": "string"
},
"schema": {
"$ref": "#/components/schemas/ProvisionRegistrationEnvelopeRequest"
}
},
"text/json": {
"example": {
"authTag": "string",
"iv": "string",
"wrappedUmk": "string"
},
"schema": {
"$ref": "#/components/schemas/ProvisionRegistrationEnvelopeRequest"
}
}
}
},
"responses": {
"202": {
"content": {
"application/json": {
"example": {
"requestedAt": "2026-01-01T00:00:00.0000000+00:00",
"sagaId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": "string"
},
"schema": {
"$ref": "#/components/schemas/ProvisionRegistrationEnvelopeResponse"
}
}
},
"description": "Saga opened; envelope provisioned, awaiting the EPIC 9 auth-hash finalisation."
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Invalid request."
},
"403": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Missing/invalid envelope-provisioning token (wrong purpose claim)."
},
"409": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "An envelope already exists, or a registration is already in progress."
}
},
"summary": "Provisions the wrapped-UMK envelope at registration via the FR-01.092\r\ninverted, envelope-first handshake (Decision D-127, option b). The caller\r\npresents a one-shot EPIC 9 envelope-provisioning token (a JWT carrying\r\n`purpose=envelope-provisioning` + the user's `sub`); EPIC 1 commits\r\nthe envelope + genesis generation, opens the registration saga, and asks\r\nEPIC 9 to finalise the login auth-hash. Returns 202 Accepted with the\r\n`saga_id`: the account becomes loginable only once EPIC 9 finalises, so\r\nno observable user ever has an auth-hash without a matching envelope.",
"tags": [
"WrappedUmk"
]
}
},
"/api/v1/keys/wrapped-umk/unlock-resolution": {
"post": {
"description": "The client MUST call this on every unlock with an identically-shaped\r\nbody, differing only in Essence.Core.MultiDeviceSync.Contracts.Requests.SignalUnlockResolutionRequest.Kind,\r\nso a coerced session cannot tell the two apart. The response is a constant\r\n`202 Accepted` for both kinds and whether or not the seam actually\r\nqueued the signal — no accepted/dropped and no duress/normal tell.\r\n\nIt is deliberately NOT on the `wrapped-umk-fetch` budget, only the\r\nplatform default limiter (#9513). The envelope fetch's five-per-hour budget\r\ncan be drained by the victim's own session; if the resolution shared it, a\r\ncoercer could drain it and then compel an unlock the alarm could not report.\r\nFor the same reason there is no per-account hourly budget of its own, which\r\nwould be drainable the same way. A client whose fetch was refused reports\r\nEssence.Core.MultiDeviceSync.Contracts.Requests.UnlockResolutionKinds.Unresolved.",
"operationId": "WrappedUmk_SignalUnlockResolution",
"requestBody": {
"content": {
"application/*+json": {
"example": {
"duressChannel": "string",
"kind": "string"
},
"schema": {
"$ref": "#/components/schemas/SignalUnlockResolutionRequest"
}
},
"application/json": {
"example": {
"duressChannel": "string",
"kind": "string"
},
"schema": {
"$ref": "#/components/schemas/SignalUnlockResolutionRequest"
}
},
"text/json": {
"example": {
"duressChannel": "string",
"kind": "string"
},
"schema": {
"$ref": "#/components/schemas/SignalUnlockResolutionRequest"
}
}
}
},
"responses": {
"202": {
"content": {
"application/json": {
"example": {
"status": "string"
},
"schema": {
"$ref": "#/components/schemas/SignalUnlockResolutionResponse"
}
}
},
"description": "Resolution acknowledged (constant for both kinds)."
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Invalid request or unresolved user identity."
},
"500": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Internal Server Error"
}
},
"summary": "Reports a locally-resolved unlock — normal OR duress — so its audit /\r\nsilent-alarm side effects are handed to the off-critical-path\r\nindistinguishability seam (FR-01.074,\r\njourney:duress-passphrase-silent-alarm-and-decoy-unlock,\r\ndebt-2026-06-13-1072). Under zero-knowledge the server never sees the\r\npassphrase and cannot resolve duress vs normal itself; the client (having\r\nunwrapped the genuine or decoy UMK locally) reports the outcome here.",
"tags": [
"WrappedUmk"
]
}
},
"/api/v1/pairing/sessions": {
"post": {
"operationId": "PairingSessions_CreatePairingSession",
"requestBody": {
"content": {
"application/*+json": {
"example": {
"challenge": "2d7e4a5b8f1c3d6e9a0b7c4d1e8f5a2b3c6d9e0f1a2b5c8d",
"deviceAId": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
"deviceAPublicKey": "{\"kty\":\"RSA\",\"n\":\"0vx7agoebGcQSuuPiLJXZpt...\",\"e\":\"AQAB\",\"alg\":\"RSA-OAEP-256\",\"key_ops\":[\"encrypt\"]}",
"expiresAt": "2025-10-14T15:15:00.0000000+00:00"
},
"schema": {
"$ref": "#/components/schemas/CreatePairingSessionRequest"
}
},
"application/json": {
"example": {
"challenge": "2d7e4a5b8f1c3d6e9a0b7c4d1e8f5a2b3c6d9e0f1a2b5c8d",
"deviceAId": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
"deviceAPublicKey": "{\"kty\":\"RSA\",\"n\":\"0vx7agoebGcQSuuPiLJXZpt...\",\"e\":\"AQAB\",\"alg\":\"RSA-OAEP-256\",\"key_ops\":[\"encrypt\"]}",
"expiresAt": "2025-10-14T15:15:00.0000000+00:00"
},
"schema": {
"$ref": "#/components/schemas/CreatePairingSessionRequest"
}
},
"text/json": {
"example": {
"challenge": "2d7e4a5b8f1c3d6e9a0b7c4d1e8f5a2b3c6d9e0f1a2b5c8d",
"deviceAId": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
"deviceAPublicKey": "{\"kty\":\"RSA\",\"n\":\"0vx7agoebGcQSuuPiLJXZpt...\",\"e\":\"AQAB\",\"alg\":\"RSA-OAEP-256\",\"key_ops\":[\"encrypt\"]}",
"expiresAt": "2025-10-14T15:15:00.0000000+00:00"
},
"schema": {
"$ref": "#/components/schemas/CreatePairingSessionRequest"
}
}
},
"description": "Create pairing session request"
},
"responses": {
"201": {
"content": {
"application/json": {
"example": {
"completedAt": "2025-10-14T15:12:30.0000000+00:00",
"createdAt": "2025-10-14T15:10:00.0000000+00:00",
"deviceAId": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
"deviceBId": "f6e5d4c3-b2a1-4f5e-8d9c-1a0b9c8d7e6f",
"deviceBPublicKey": "{\"kty\":\"RSA\",\"n\":\"xGOvx8i9Z2Pt1KYz...\",\"e\":\"AQAB\",\"alg\":\"RSA-OAEP-256\"}",
"expiresAt": "2025-10-14T15:15:00.0000000+00:00",
"isExpired": false,
"joinedAt": "2025-10-14T15:11:10.0000000+00:00",
"joinerFriendlyName": "Pixel 8",
"joinerProvenance": "Manchester, UK · same network",
"joinerSigningKeyApprovedAt": "2026-01-01T00:00:00.0000000+00:00",
"joinerSigningKeyThumbprint": "string",
"pairingSessionId": "550e8400-e29b-41d4-a716-446655440000",
"status": "Completed",
"timeRemaining": "00:02:30",
"wrappedMasterKey": "9f0e1d2c3b4a5968e7d6c5b4a39281706f5e4d3c2b1a0988776655443322110fedcba9876543210"
},
"schema": {
"$ref": "#/components/schemas/PairingSessionResponse"
}
}
},
"description": "Pairing session created successfully"
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Invalid request"
},
"409": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Conflict"
},
"429": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Too Many Requests"
},
"500": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Internal server error"
}
},
"summary": "Creates a new pairing session (Device A).",
"tags": [
"PairingSessions"
]
}
},
"/api/v1/pairing/sessions/{id}": {
"delete": {
"operationId": "PairingSessions_CancelPairingSession",
"parameters": [
{
"description": "Pairing session ID",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Pairing session cancelled"
},
"403": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "The joining device — only the initiator may cancel"
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Pairing session not found (or caller is not a participant — #9869)"
},
"409": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Pairing session already completed"
},
"500": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Internal Server Error"
}
},
"summary": "Cancels a pairing session. Only the session initiator can cancel.",
"tags": [
"PairingSessions"
]
},
"get": {
"operationId": "PairingSessions_GetPairingSession",
"parameters": [
{
"description": "Pairing session ID",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"completedAt": "2025-10-14T15:12:30.0000000+00:00",
"createdAt": "2025-10-14T15:10:00.0000000+00:00",
"deviceAId": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
"deviceBId": "f6e5d4c3-b2a1-4f5e-8d9c-1a0b9c8d7e6f",
"deviceBPublicKey": "{\"kty\":\"RSA\",\"n\":\"xGOvx8i9Z2Pt1KYz...\",\"e\":\"AQAB\",\"alg\":\"RSA-OAEP-256\"}",
"expiresAt": "2025-10-14T15:15:00.0000000+00:00",
"isExpired": false,
"joinedAt": "2025-10-14T15:11:10.0000000+00:00",
"joinerFriendlyName": "Pixel 8",
"joinerProvenance": "Manchester, UK · same network",
"joinerSigningKeyApprovedAt": "2026-01-01T00:00:00.0000000+00:00",
"joinerSigningKeyThumbprint": "string",
"pairingSessionId": "550e8400-e29b-41d4-a716-446655440000",
"status": "Completed",
"timeRemaining": "00:02:30",
"wrappedMasterKey": "9f0e1d2c3b4a5968e7d6c5b4a39281706f5e4d3c2b1a0988776655443322110fedcba9876543210"
},
"schema": {
"$ref": "#/components/schemas/PairingSessionResponse"
}
}
},
"description": "Pairing session found"
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Pairing session not found"
},
"500": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Internal server error"
}
},
"summary": "Gets a pairing session by ID.",
"tags": [
"PairingSessions"
]
}
},
"/api/v1/pairing/sessions/{id}/confirm": {
"post": {
"operationId": "PairingSessions_ConfirmPairing",
"parameters": [
{
"description": "Pairing session ID",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/*+json": {
"example": {
"deviceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"fingerprintConfirmed": false,
"sasConfirmation": "string"
},
"schema": {
"$ref": "#/components/schemas/ConfirmPairingRequest"
}
},
"application/json": {
"example": {
"deviceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"fingerprintConfirmed": false,
"sasConfirmation": "string"
},
"schema": {
"$ref": "#/components/schemas/ConfirmPairingRequest"
}
},
"text/json": {
"example": {
"deviceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"fingerprintConfirmed": false,
"sasConfirmation": "string"
},
"schema": {
"$ref": "#/components/schemas/ConfirmPairingRequest"
}
}
},
"description": "Confirm request with device ID and confirmation flag"
},
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"completedAt": "2025-10-14T15:12:30.0000000+00:00",
"createdAt": "2025-10-14T15:10:00.0000000+00:00",
"deviceAId": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
"deviceBId": "f6e5d4c3-b2a1-4f5e-8d9c-1a0b9c8d7e6f",
"deviceBPublicKey": "{\"kty\":\"RSA\",\"n\":\"xGOvx8i9Z2Pt1KYz...\",\"e\":\"AQAB\",\"alg\":\"RSA-OAEP-256\"}",
"expiresAt": "2025-10-14T15:15:00.0000000+00:00",
"isExpired": false,
"joinedAt": "2025-10-14T15:11:10.0000000+00:00",
"joinerFriendlyName": "Pixel 8",
"joinerProvenance": "Manchester, UK · same network",
"joinerSigningKeyApprovedAt": "2026-01-01T00:00:00.0000000+00:00",
"joinerSigningKeyThumbprint": "string",
"pairingSessionId": "550e8400-e29b-41d4-a716-446655440000",
"status": "Completed",
"timeRemaining": "00:02:30",
"wrappedMasterKey": "9f0e1d2c3b4a5968e7d6c5b4a39281706f5e4d3c2b1a0988776655443322110fedcba9876543210"
},
"schema": {
"$ref": "#/components/schemas/PairingSessionResponse"
}
}
},
"description": "Confirmation recorded"
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Bad Request"
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Pairing session not found"
},
"410": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Pairing session expired"
},
"500": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Internal Server Error"
}
},
"summary": "Confirms fingerprint verification during pairing (FR-01.006).\r\nBoth devices call this after visually confirming the fingerprint match.",
"tags": [
"PairingSessions"
]
}
},
"/api/v1/pairing/sessions/{id}/exchange": {
"post": {
"operationId": "PairingSessions_CompletePairing",
"parameters": [
{
"description": "Pairing session ID",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/*+json": {
"example": {
"approvedJoinerSigningKeyThumbprint": "string",
"wrappedMasterKey": "base64(RSA-OAEP-256(masterKey)) — e.g. \"9f0e1d2c…\" (truncated)"
},
"schema": {
"$ref": "#/components/schemas/CompletePairingRequest"
}
},
"application/json": {
"example": {
"approvedJoinerSigningKeyThumbprint": "string",
"wrappedMasterKey": "base64(RSA-OAEP-256(masterKey)) — e.g. \"9f0e1d2c…\" (truncated)"
},
"schema": {
"$ref": "#/components/schemas/CompletePairingRequest"
}
},
"text/json": {
"example": {
"approvedJoinerSigningKeyThumbprint": "string",
"wrappedMasterKey": "base64(RSA-OAEP-256(masterKey)) — e.g. \"9f0e1d2c…\" (truncated)"
},
"schema": {
"$ref": "#/components/schemas/CompletePairingRequest"
}
}
},
"description": "Complete pairing request"
},
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"completedAt": "2025-10-14T15:12:30.0000000+00:00",
"createdAt": "2025-10-14T15:10:00.0000000+00:00",
"deviceAId": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
"deviceBId": "f6e5d4c3-b2a1-4f5e-8d9c-1a0b9c8d7e6f",
"deviceBPublicKey": "{\"kty\":\"RSA\",\"n\":\"xGOvx8i9Z2Pt1KYz...\",\"e\":\"AQAB\",\"alg\":\"RSA-OAEP-256\"}",
"expiresAt": "2025-10-14T15:15:00.0000000+00:00",
"isExpired": false,
"joinedAt": "2025-10-14T15:11:10.0000000+00:00",
"joinerFriendlyName": "Pixel 8",
"joinerProvenance": "Manchester, UK · same network",
"joinerSigningKeyApprovedAt": "2026-01-01T00:00:00.0000000+00:00",
"joinerSigningKeyThumbprint": "string",
"pairingSessionId": "550e8400-e29b-41d4-a716-446655440000",
"status": "Completed",
"timeRemaining": "00:02:30",
"wrappedMasterKey": "9f0e1d2c3b4a5968e7d6c5b4a39281706f5e4d3c2b1a0988776655443322110fedcba9876543210"
},
"schema": {
"$ref": "#/components/schemas/PairingSessionResponse"
}
}
},
"description": "Pairing completed successfully"
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Invalid request"
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Pairing session not found"
},
"410": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Pairing session expired"
},
"500": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Internal server error"
}
},
"summary": "Device A completes the pairing by providing the wrapped master key.",
"tags": [
"PairingSessions"
]
}
},
"/api/v1/pairing/sessions/{id}/extend": {
"post": {
"operationId": "PairingSessions_ExtendPairing",
"parameters": [
{
"description": "Pairing session ID",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"completedAt": "2025-10-14T15:12:30.0000000+00:00",
"createdAt": "2025-10-14T15:10:00.0000000+00:00",
"deviceAId": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
"deviceBId": "f6e5d4c3-b2a1-4f5e-8d9c-1a0b9c8d7e6f",
"deviceBPublicKey": "{\"kty\":\"RSA\",\"n\":\"xGOvx8i9Z2Pt1KYz...\",\"e\":\"AQAB\",\"alg\":\"RSA-OAEP-256\"}",
"expiresAt": "2025-10-14T15:15:00.0000000+00:00",
"isExpired": false,
"joinedAt": "2025-10-14T15:11:10.0000000+00:00",
"joinerFriendlyName": "Pixel 8",
"joinerProvenance": "Manchester, UK · same network",
"joinerSigningKeyApprovedAt": "2026-01-01T00:00:00.0000000+00:00",
"joinerSigningKeyThumbprint": "string",
"pairingSessionId": "550e8400-e29b-41d4-a716-446655440000",
"status": "Completed",
"timeRemaining": "00:02:30",
"wrappedMasterKey": "9f0e1d2c3b4a5968e7d6c5b4a39281706f5e4d3c2b1a0988776655443322110fedcba9876543210"
},
"schema": {
"$ref": "#/components/schemas/PairingSessionResponse"
}
}
},
"description": "Session extended (or already at the aggregate cap — idempotent)."
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Session is past the pre-key-exchange phase."
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Pairing session not found (or caller is not a participant)."
},
"410": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Pairing session already expired."
},
"500": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Internal Server Error"
}
},
"summary": "Extends a pre-key-exchange pairing session's expiry within the FR-01.006\r\nwindow (debt-2026-07-03-006). Backs the approval surface's warn-at-20% +\r\none-action \"Extend\" so the user can avoid the WCAG 2.2.1 timing cut-off\r\nwithout re-pairing — the same QR/comparison code is preserved.",
"tags": [
"PairingSessions"
]
}
},
"/api/v1/pairing/sessions/{id}/join": {
"post": {
"operationId": "PairingSessions_RespondToPairing",
"parameters": [
{
"description": "Pairing session ID",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/*+json": {
"example": {
"challengeSolution": "8a9b0c1d2e3f4a5b6c7d8e9f0a1b2c3d4e5f6a7b8c9d0e1f",
"deviceBId": "f6e5d4c3-b2a1-4f5e-8d9c-1a0b9c8d7e6f",
"deviceBPublicKey": "{\"kty\":\"RSA\",\"n\":\"xGOvx8i9Z2Pt1KYz...\",\"e\":\"AQAB\",\"alg\":\"RSA-OAEP-256\",\"key_ops\":[\"encrypt\"]}",
"deviceBSigningKeyJwk": "string",
"deviceFriendlyName": "Pixel 8",
"deviceProvenance": "Manchester, UK · same network"
},
"schema": {
"$ref": "#/components/schemas/RespondToPairingRequest"
}
},
"application/json": {
"example": {
"challengeSolution": "8a9b0c1d2e3f4a5b6c7d8e9f0a1b2c3d4e5f6a7b8c9d0e1f",
"deviceBId": "f6e5d4c3-b2a1-4f5e-8d9c-1a0b9c8d7e6f",
"deviceBPublicKey": "{\"kty\":\"RSA\",\"n\":\"xGOvx8i9Z2Pt1KYz...\",\"e\":\"AQAB\",\"alg\":\"RSA-OAEP-256\",\"key_ops\":[\"encrypt\"]}",
"deviceBSigningKeyJwk": "string",
"deviceFriendlyName": "Pixel 8",
"deviceProvenance": "Manchester, UK · same network"
},
"schema": {
"$ref": "#/components/schemas/RespondToPairingRequest"
}
},
"text/json": {
"example": {
"challengeSolution": "8a9b0c1d2e3f4a5b6c7d8e9f0a1b2c3d4e5f6a7b8c9d0e1f",
"deviceBId": "f6e5d4c3-b2a1-4f5e-8d9c-1a0b9c8d7e6f",
"deviceBPublicKey": "{\"kty\":\"RSA\",\"n\":\"xGOvx8i9Z2Pt1KYz...\",\"e\":\"AQAB\",\"alg\":\"RSA-OAEP-256\",\"key_ops\":[\"encrypt\"]}",
"deviceBSigningKeyJwk": "string",
"deviceFriendlyName": "Pixel 8",
"deviceProvenance": "Manchester, UK · same network"
},
"schema": {
"$ref": "#/components/schemas/RespondToPairingRequest"
}
}
},
"description": "Respond to pairing request"
},
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"completedAt": "2025-10-14T15:12:30.0000000+00:00",
"createdAt": "2025-10-14T15:10:00.0000000+00:00",
"deviceAId": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
"deviceBId": "f6e5d4c3-b2a1-4f5e-8d9c-1a0b9c8d7e6f",
"deviceBPublicKey": "{\"kty\":\"RSA\",\"n\":\"xGOvx8i9Z2Pt1KYz...\",\"e\":\"AQAB\",\"alg\":\"RSA-OAEP-256\"}",
"expiresAt": "2025-10-14T15:15:00.0000000+00:00",
"isExpired": false,
"joinedAt": "2025-10-14T15:11:10.0000000+00:00",
"joinerFriendlyName": "Pixel 8",
"joinerProvenance": "Manchester, UK · same network",
"joinerSigningKeyApprovedAt": "2026-01-01T00:00:00.0000000+00:00",
"joinerSigningKeyThumbprint": "string",
"pairingSessionId": "550e8400-e29b-41d4-a716-446655440000",
"status": "Completed",
"timeRemaining": "00:02:30",
"wrappedMasterKey": "9f0e1d2c3b4a5968e7d6c5b4a39281706f5e4d3c2b1a0988776655443322110fedcba9876543210"
},
"schema": {
"$ref": "#/components/schemas/PairingSessionResponse"
}
}
},
"description": "Response recorded successfully"
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Invalid request"
},
"401": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Pairing session not found"
},
"409": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Conflict"
},
"410": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Pairing session expired"
},
"500": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Internal server error"
}
},
"summary": "Device B responds to a pairing session after scanning QR code.",
"tags": [
"PairingSessions"
]
}
},
"/api/v1/protection-status/alternate-passphrase": {
"put": {
"description": "FR-66.182 (#22211): with `behaviourAcknowledgementVersion` this is how an owner who\r\narmed under an earlier explanation confirms the current one, without re-arming. It is a\r\nphase of this action rather than an action of its own because the controller is at its\r\nCAP-011b origin ceiling.",
"operationId": "ProtectionStatus_SetAlternatePassphrase",
"requestBody": {
"content": {
"application/*+json": {
"example": {
"behaviourAcknowledgementVersion": "string",
"provisioned": false
},
"schema": {
"$ref": "#/components/schemas/SetAlternatePassphraseStatusRequest"
}
},
"application/json": {
"example": {
"behaviourAcknowledgementVersion": "string",
"provisioned": false
},
"schema": {
"$ref": "#/components/schemas/SetAlternatePassphraseStatusRequest"
}
},
"text/json": {
"example": {
"behaviourAcknowledgementVersion": "string",
"provisioned": false
},
"schema": {
"$ref": "#/components/schemas/SetAlternatePassphraseStatusRequest"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"alternatePassphraseChangedAt": "2026-01-01T00:00:00.0000000+00:00",
"alternatePassphraseProvisioned": false,
"backupVaultChangedAt": "2026-01-01T00:00:00.0000000+00:00",
"backupVaultLastReviewedAt": "2026-01-01T00:00:00.0000000+00:00",
"backupVaultPresent": false,
"behaviourAcknowledgedAt": "2026-01-01T00:00:00.0000000+00:00",
"behaviourAcknowledgementVersion": "string"
},
"schema": {
"$ref": "#/components/schemas/ProtectionStatusResponse"
}
}
},
"description": "Status recorded; the owner's current protection status returned."
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Invalid request / unresolvable user identity."
},
"409": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "An acknowledgement was sent but no alternate passphrase is armed (`reason=not-armed`)."
},
"500": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Internal Server Error"
}
},
"summary": "Reports whether the owner currently has a duress/alternate passphrase provisioned, and\r\noptionally re-acknowledges the behaviour explanation on an armed arrangement.",
"tags": [
"ProtectionStatus"
]
}
},
"/api/v1/protection-status/backup-vault": {
"put": {
"operationId": "ProtectionStatus_SetBackupVault",
"requestBody": {
"content": {
"application/*+json": {
"example": {
"lastReviewedAt": "2026-01-01T00:00:00.0000000+00:00",
"present": false
},
"schema": {
"$ref": "#/components/schemas/SetBackupVaultStatusRequest"
}
},
"application/json": {
"example": {
"lastReviewedAt": "2026-01-01T00:00:00.0000000+00:00",
"present": false
},
"schema": {
"$ref": "#/components/schemas/SetBackupVaultStatusRequest"
}
},
"text/json": {
"example": {
"lastReviewedAt": "2026-01-01T00:00:00.0000000+00:00",
"present": false
},
"schema": {
"$ref": "#/components/schemas/SetBackupVaultStatusRequest"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"alternatePassphraseChangedAt": "2026-01-01T00:00:00.0000000+00:00",
"alternatePassphraseProvisioned": false,
"backupVaultChangedAt": "2026-01-01T00:00:00.0000000+00:00",
"backupVaultLastReviewedAt": "2026-01-01T00:00:00.0000000+00:00",
"backupVaultPresent": false,
"behaviourAcknowledgedAt": "2026-01-01T00:00:00.0000000+00:00",
"behaviourAcknowledgementVersion": "string"
},
"schema": {
"$ref": "#/components/schemas/ProtectionStatusResponse"
}
}
},
"description": "Status recorded; the owner's current protection status returned."
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Invalid request / unresolvable user identity."
},
"500": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Internal Server Error"
}
},
"summary": "Reports the backup/decoy vault's presence and last-review freshness.",
"tags": [
"ProtectionStatus"
]
}
},
"/api/v1/recovery/assisted/authorisations": {
"post": {
"operationId": "AssistedRecovery_Authorise",
"requestBody": {
"content": {
"application/*+json": {
"example": {
"enrolmentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"proofingEvidenceRef": "string"
},
"schema": {
"$ref": "#/components/schemas/IssueAssistedRecoveryAuthorizationRequest"
}
},
"application/json": {
"example": {
"enrolmentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"proofingEvidenceRef": "string"
},
"schema": {
"$ref": "#/components/schemas/IssueAssistedRecoveryAuthorizationRequest"
}
},
"text/json": {
"example": {
"enrolmentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"proofingEvidenceRef": "string"
},
"schema": {
"$ref": "#/components/schemas/IssueAssistedRecoveryAuthorizationRequest"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"example": {
"anchorRef": "string",
"authorisingAdminId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"enrolmentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"issuedAt": "2026-01-01T00:00:00.0000000+00:00",
"recoveryTokenRef": "string",
"scope": "string",
"stepUpAssuranceLevel": "string",
"subjectUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"zkAttestation": "string"
},
"schema": {
"$ref": "#/components/schemas/AssistedRecoveryGrantResponse"
}
}
},
"description": "Created"
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Bad Request"
},
"403": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Not Found"
}
},
"summary": "Authorises a locked-out subject's account recovery (authorise-only). Returns\r\nonly opaque references — never key material.",
"tags": [
"AssistedRecovery"
]
}
},
"/api/v1/recovery/assisted/authorisations/{recoveryTokenRef}/confirmation": {
"get": {
"description": "\n\r\n The compliance read-back behind the zero-knowledge attestation. Where\r\n M:Essence.Core.MultiDeviceSync.Api.Controllers.AssistedRecoveryController.Authorise(Essence.Core.MultiDeviceSync.Contracts.Requests.IssueAssistedRecoveryAuthorizationRequest,System.Threading.CancellationToken) reports what the issuing call did, this re-derives the\r\n verdict from the sealed, tamper-evident audit entry — so a reviewer is checking\r\n evidence rather than trusting the requesting service's claim about itself.\r\n \r\n\n\r\n Gated to the same `EscrowAuditExport` compliance policy as the sibling audit\r\n read/verify endpoints (a break-glass compliance artifact, not a tenant-user\r\n surface), with the same per-enrolment org binding applied inside the handler: a\r\n caller whose org has no custody of the resolved enrolment gets 404, not 403, so\r\n the endpoint cannot be used to confirm that a reference exists.\r\n ",
"operationId": "AssistedRecovery_GetConfirmation",
"parameters": [
{
"in": "path",
"name": "recoveryTokenRef",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"anchorRef": "string",
"attestationMatchesCanonical": false,
"auditEntryHash": "string",
"auditEntryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"authorisedAt": "2026-01-01T00:00:00.0000000+00:00",
"authorisingAdminId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"confirmed": false,
"enrolmentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"grantScopeAuthoriseOnly": false,
"grantType": "string",
"noDecryptCapabilityReleased": false,
"recoveryTokenRef": "string",
"sealVerified": false,
"subjectUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"unconfirmedReason": "string",
"zkAttestation": "string"
},
"schema": {
"$ref": "#/components/schemas/AssistedRecoveryGrantConfirmationResponse"
}
}
},
"description": "OK"
},
"401": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Not Found"
}
},
"summary": "Independently confirms that the authorisation identified by\r\nrecoveryTokenRef issued the CC-061 authorise-only grant and\r\nthat no decrypt capability was released off the back of it\r\n(debt-2026-08-10-012).",
"tags": [
"AssistedRecovery"
]
}
},
"/api/v1/recovery/biometric-mismatch/fallback-code": {
"put": {
"operationId": "BiometricMismatchRecovery_EnrolFallbackCode",
"requestBody": {
"content": {
"application/*+json": {
"example": {
"recoveryCode": "string"
},
"schema": {
"$ref": "#/components/schemas/EnrolFallbackRecoveryCodeRequest"
}
},
"application/json": {
"example": {
"recoveryCode": "string"
},
"schema": {
"$ref": "#/components/schemas/EnrolFallbackRecoveryCodeRequest"
}
},
"text/json": {
"example": {
"recoveryCode": "string"
},
"schema": {
"$ref": "#/components/schemas/EnrolFallbackRecoveryCodeRequest"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"enrolledAt": "2026-01-01T00:00:00.0000000+00:00"
},
"schema": {
"$ref": "#/components/schemas/FallbackRecoveryEnrolmentResponse"
}
}
},
"description": "Fallback verifier enrolled."
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Invalid request / unresolvable user identity."
},
"401": {
"description": "No fresh `act=recovery-settings-change` elevation (`step-up-required`, DVS-4.4c)."
},
"423": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Locked"
},
"500": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Internal Server Error"
}
},
"summary": "Enrols / replaces the authenticated holder's fallback recovery code (FR-01.072).",
"tags": [
"BiometricMismatchRecovery"
]
}
},
"/api/v1/recovery/biometric-mismatch/rebind": {
"post": {
"operationId": "BiometricMismatchRecovery_Rebind",
"requestBody": {
"content": {
"application/*+json": {
"example": {
"assuranceRef": "string",
"authTag": "string",
"deviceId": "string",
"deviceName": "string",
"deviceType": "string",
"iv": "string",
"publicKey": "string",
"revokePreviousDevice": false,
"wrappedUmk": "string"
},
"schema": {
"$ref": "#/components/schemas/RebindAfterBiometricMismatchRequest"
}
},
"application/json": {
"example": {
"assuranceRef": "string",
"authTag": "string",
"deviceId": "string",
"deviceName": "string",
"deviceType": "string",
"iv": "string",
"publicKey": "string",
"revokePreviousDevice": false,
"wrappedUmk": "string"
},
"schema": {
"$ref": "#/components/schemas/RebindAfterBiometricMismatchRequest"
}
},
"text/json": {
"example": {
"assuranceRef": "string",
"authTag": "string",
"deviceId": "string",
"deviceName": "string",
"deviceType": "string",
"iv": "string",
"publicKey": "string",
"revokePreviousDevice": false,
"wrappedUmk": "string"
},
"schema": {
"$ref": "#/components/schemas/RebindAfterBiometricMismatchRequest"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"assuranceRef": "string",
"deviceName": "string",
"keysRebound": false,
"previousDeviceName": "string",
"previousDeviceStatus": "string",
"reestablishedAt": "2026-01-01T00:00:00.0000000+00:00"
},
"schema": {
"$ref": "#/components/schemas/BiometricMismatchRebindResponse"
}
}
},
"description": "Device re-bound; delta returned."
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Invalid request / unresolvable user identity."
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "No usable assurance for this reference / caller."
},
"409": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Assurance already consumed."
},
"422": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Assurance expired."
},
"500": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Internal Server Error"
}
},
"summary": "Spends a verified assurance to re-bind the re-established device and returns the\r\n\"what changed\" delta (FR-01.072). Emits the FR-66.159 confirmation via the outbox.",
"tags": [
"BiometricMismatchRecovery"
]
}
},
"/api/v1/recovery/biometric-mismatch/verify": {
"post": {
"operationId": "BiometricMismatchRecovery_Verify",
"requestBody": {
"content": {
"application/*+json": {
"example": {
"recoveryCode": "string"
},
"schema": {
"$ref": "#/components/schemas/VerifyBiometricMismatchFallbackRequest"
}
},
"application/json": {
"example": {
"recoveryCode": "string"
},
"schema": {
"$ref": "#/components/schemas/VerifyBiometricMismatchFallbackRequest"
}
},
"text/json": {
"example": {
"recoveryCode": "string"
},
"schema": {
"$ref": "#/components/schemas/VerifyBiometricMismatchFallbackRequest"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"assuranceRef": "string",
"expiresAt": "2026-01-01T00:00:00.0000000+00:00"
},
"schema": {
"$ref": "#/components/schemas/BiometricMismatchAssuranceResponse"
}
}
},
"description": "Fallback code verified; assurance minted."
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Invalid request / unresolvable user identity."
},
"403": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Fallback proof invalid (generic — no enumeration oracle)."
},
"429": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Verification rate limit exceeded."
},
"500": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Internal Server Error"
}
},
"summary": "Verifies a presented fallback recovery code and, on success, mints a short-lived re-bind\r\nassurance (FR-01.072). A wrong code or no enrolled verifier both return a generic 403.",
"tags": [
"BiometricMismatchRecovery"
]
}
},
"/api/v1/recovery/sessions": {
"post": {
"operationId": "RecoverySessions_Initiate",
"requestBody": {
"content": {
"application/*+json": {
"example": {
"configId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"reason": "string"
},
"schema": {
"$ref": "#/components/schemas/InitiateRecoverySessionRequest"
}
},
"application/json": {
"example": {
"configId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"reason": "string"
},
"schema": {
"$ref": "#/components/schemas/InitiateRecoverySessionRequest"
}
},
"text/json": {
"example": {
"configId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"reason": "string"
},
"schema": {
"$ref": "#/components/schemas/InitiateRecoverySessionRequest"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"example": {
"absoluteExpiresAt": "2026-01-01T00:00:00.0000000+00:00",
"canExtend": false,
"configId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"effectiveDeadline": "2026-01-01T00:00:00.0000000+00:00",
"expiresAt": "2026-01-01T00:00:00.0000000+00:00",
"extensionCount": 0,
"extensionsRemaining": 0,
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"initiatedAt": "2026-01-01T00:00:00.0000000+00:00",
"status": "string",
"userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"schema": {
"$ref": "#/components/schemas/RecoverySessionResponse"
}
}
},
"description": "Recovery session created."
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Invalid request / unresolvable user identity."
},
"429": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Recovery-initiation rate limit exceeded (NFR-01.069)."
},
"500": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Internal Server Error"
}
},
"summary": "Initiates a recovery session, stamping the FR-01.064 timeout window.",
"tags": [
"RecoverySessions"
]
}
},
"/api/v1/recovery/sessions/{id}": {
"get": {
"operationId": "RecoverySessions_GetSession",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"absoluteExpiresAt": "2026-01-01T00:00:00.0000000+00:00",
"canExtend": false,
"configId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"effectiveDeadline": "2026-01-01T00:00:00.0000000+00:00",
"expiresAt": "2026-01-01T00:00:00.0000000+00:00",
"extensionCount": 0,
"extensionsRemaining": 0,
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"initiatedAt": "2026-01-01T00:00:00.0000000+00:00",
"status": "string",
"userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"schema": {
"$ref": "#/components/schemas/RecoverySessionResponse"
}
}
},
"description": "Session found."
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Session not found (or not owned by the caller)."
},
"500": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Internal Server Error"
}
},
"summary": "Reads a recovery session's server-authoritative timeout window.",
"tags": [
"RecoverySessions"
]
}
},
"/api/v1/recovery/sessions/{id}/keepalive": {
"post": {
"operationId": "RecoverySessions_KeepAlive",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"absoluteExpiresAt": "2026-01-01T00:00:00.0000000+00:00",
"canExtend": false,
"configId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"effectiveDeadline": "2026-01-01T00:00:00.0000000+00:00",
"expiresAt": "2026-01-01T00:00:00.0000000+00:00",
"extensionCount": 0,
"extensionsRemaining": 0,
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"initiatedAt": "2026-01-01T00:00:00.0000000+00:00",
"status": "string",
"userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"schema": {
"$ref": "#/components/schemas/RecoverySessionResponse"
}
}
},
"description": "Idle window re-armed; updated deadlines returned."
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Session not found (or not owned by the caller)."
},
"409": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "At the absolute security ceiling or the extension cap."
},
"422": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "The session has already lapsed or is terminal."
},
"500": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Internal Server Error"
}
},
"summary": "Re-arms the idle window (\"Need more time?\"). Refuses past the absolute\r\nsecurity ceiling / extension cap (409) and on a lapsed / terminal session\r\n(422) — the server-side enforcement of the recovery-timeout ceiling.",
"tags": [
"RecoverySessions"
]
}
},
"/api/v1/rotation/obligations": {
"get": {
"operationId": "RotationObligations_ListOpen",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/KeyRotationObligationResponse"
},
"type": "array"
}
}
},
"description": "The open obligations; an empty list when nothing is owed."
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "The token carries no user identity."
}
},
"summary": "Lists the caller's open device-removal rotation obligations, oldest removal first.",
"tags": [
"RotationObligations"
]
}
},
"/api/v1/rotation/obligations/emergency-key": {
"get": {
"operationId": "RotationObligations_ListOpenEmergencyKey",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/EakRotationObligationResponse"
},
"type": "array"
}
}
},
"description": "The open obligations; an empty list when nothing is owed."
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "The token carries no user identity."
}
},
"summary": "Lists the caller's open emergency-key rotation obligations, oldest exposure first\r\n(FR-01.042(d), #22167): rotations owed because a break-glass grant was revoked after its\r\nEmergency Access Key had been reconstructed, so the key is treated as known-exposed.",
"tags": [
"RotationObligations"
]
}
},
"/api/v1/rotation/obligations/emergency-key/{id}/defer": {
"post": {
"operationId": "RotationObligations_DeferEmergencyKey",
"parameters": [
{
"description": "The obligation id from `GET /api/v1/rotation/obligations/emergency-key`.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"anchorReference": "string",
"deferralCount": 0,
"deferredAt": "2026-01-01T00:00:00.0000000+00:00",
"deferredUntil": "2026-01-01T00:00:00.0000000+00:00",
"exposedAt": "2026-01-01T00:00:00.0000000+00:00",
"obligationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"schema": {
"$ref": "#/components/schemas/EakRotationDeferralResponse"
}
}
},
"description": "The defer was recorded and anchored."
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "The token carries no user identity."
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "The caller owes no such rotation."
},
"409": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "The rotation is already done (`already-rotated`) or already deferred (`already-deferred`)."
}
},
"summary": "Defers one of the caller's emergency-key rotations for one cadence period (FR-01.043 /\r\nAC-01.044 (c), #22248). The defer is recorded on the escrow audit chain and anchored to the\r\nEPIC 4 ledger as \"offered, chose to defer, residual exposure window\"; the reminder returns\r\nwhen it runs out. One defer per reminder — the rotation can be put off, never suppressed.",
"tags": [
"RotationObligations"
]
}
},
"/api/v1/rotation/sessions": {
"post": {
"operationId": "KeyRotation_InitiateRotation",
"requestBody": {
"content": {
"application/*+json": {
"example": {
"deviceId": "string",
"totalItems": 0,
"trigger": "string"
},
"schema": {
"$ref": "#/components/schemas/InitiateKeyRotationRequest"
}
},
"application/json": {
"example": {
"deviceId": "string",
"totalItems": 0,
"trigger": "string"
},
"schema": {
"$ref": "#/components/schemas/InitiateKeyRotationRequest"
}
},
"text/json": {
"example": {
"deviceId": "string",
"totalItems": 0,
"trigger": "string"
},
"schema": {
"$ref": "#/components/schemas/InitiateKeyRotationRequest"
}
}
},
"description": "Initiate rotation request"
},
"responses": {
"201": {
"content": {
"application/json": {
"example": {
"carriedPasskeyCount": 0,
"checkpointData": "string",
"completedAt": "2026-01-01T00:00:00.0000000+00:00",
"coverageConfirmed": false,
"coveredItemCount": 0,
"deviceId": "string",
"dualKeyWindowExpiresAt": "2026-01-01T00:00:00.0000000+00:00",
"failureReason": "string",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"introducedGeneration": "string",
"lastCheckpointAt": "2026-01-01T00:00:00.0000000+00:00",
"newGenerationEnvelopeHeld": false,
"oldGenerationItemCount": 0,
"progressPercentage": 0,
"revokedPasskeyCount": 0,
"rotatedItems": 0,
"startedAt": "2026-01-01T00:00:00.0000000+00:00",
"status": "string",
"totalItems": 0,
"trigger": "string",
"userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"schema": {
"$ref": "#/components/schemas/KeyRotationSessionResponse"
}
}
},
"description": "Key rotation session created"
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Invalid request"
},
"401": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "No acceptable step-up elevation was presented on `X-Step-Up-Token` (reason `stepup_required`, #14203)"
},
"409": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "A rotation is already active for this user (FR-01.050 single-active-rotation invariant), or rotation is withdrawn (reason `rotation-unavailable`, #16462)"
},
"423": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Locked"
},
"500": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Internal Server Error"
}
},
"summary": "Initiates a new key rotation session.",
"tags": [
"KeyRotation"
]
}
},
"/api/v1/rotation/sessions/{id}": {
"get": {
"operationId": "KeyRotation_GetRotationStatus",
"parameters": [
{
"description": "Key rotation session ID",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"carriedPasskeyCount": 0,
"checkpointData": "string",
"completedAt": "2026-01-01T00:00:00.0000000+00:00",
"coverageConfirmed": false,
"coveredItemCount": 0,
"deviceId": "string",
"dualKeyWindowExpiresAt": "2026-01-01T00:00:00.0000000+00:00",
"failureReason": "string",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"introducedGeneration": "string",
"lastCheckpointAt": "2026-01-01T00:00:00.0000000+00:00",
"newGenerationEnvelopeHeld": false,
"oldGenerationItemCount": 0,
"progressPercentage": 0,
"revokedPasskeyCount": 0,
"rotatedItems": 0,
"startedAt": "2026-01-01T00:00:00.0000000+00:00",
"status": "string",
"totalItems": 0,
"trigger": "string",
"userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"schema": {
"$ref": "#/components/schemas/KeyRotationSessionResponse"
}
}
},
"description": "Session found"
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Session not found"
},
"500": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Internal Server Error"
}
},
"summary": "Gets the status of a key rotation session.",
"tags": [
"KeyRotation"
]
}
},
"/api/v1/rotation/sessions/{id}/cancel": {
"post": {
"description": "The OLD key generation stays write-authoritative and the single-active-rotation slot\r\n(FR-01.050) is freed, so a rotation interrupted by a closed tab no longer blocks the next\r\none until the abandonment reaper runs (#7278). Like the other continuation calls it does\r\nnot re-ask for step-up: it acts on a session only an elevated `POST` can have opened,\r\nand it moves the vault toward the key already in force, never away from it.",
"operationId": "KeyRotationCancellation_CancelRotation",
"parameters": [
{
"description": "Key rotation session ID",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"carriedPasskeyCount": 0,
"checkpointData": "string",
"completedAt": "2026-01-01T00:00:00.0000000+00:00",
"coverageConfirmed": false,
"coveredItemCount": 0,
"deviceId": "string",
"dualKeyWindowExpiresAt": "2026-01-01T00:00:00.0000000+00:00",
"failureReason": "string",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"introducedGeneration": "string",
"lastCheckpointAt": "2026-01-01T00:00:00.0000000+00:00",
"newGenerationEnvelopeHeld": false,
"oldGenerationItemCount": 0,
"progressPercentage": 0,
"revokedPasskeyCount": 0,
"rotatedItems": 0,
"startedAt": "2026-01-01T00:00:00.0000000+00:00",
"status": "string",
"totalItems": 0,
"trigger": "string",
"userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"schema": {
"$ref": "#/components/schemas/KeyRotationSessionResponse"
}
}
},
"description": "Rotation cancelled (or had already ended without completing)"
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "The rotation has already completed and cannot be cancelled"
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Session not found (or owned by another user)"
},
"500": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Internal Server Error"
}
},
"summary": "Cancels an open key rotation session at the user's request (FR-01.051).",
"tags": [
"KeyRotationCancellation"
]
}
},
"/api/v1/rotation/sessions/{id}/checkpoint": {
"post": {
"operationId": "KeyRotation_SaveCheckpoint",
"parameters": [
{
"description": "Key rotation session ID",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/*+json": {
"example": {
"checkpointData": "string",
"rotatedItems": 0
},
"schema": {
"$ref": "#/components/schemas/CheckpointRotationRequest"
}
},
"application/json": {
"example": {
"checkpointData": "string",
"rotatedItems": 0
},
"schema": {
"$ref": "#/components/schemas/CheckpointRotationRequest"
}
},
"text/json": {
"example": {
"checkpointData": "string",
"rotatedItems": 0
},
"schema": {
"$ref": "#/components/schemas/CheckpointRotationRequest"
}
}
},
"description": "Checkpoint data"
},
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"carriedPasskeyCount": 0,
"checkpointData": "string",
"completedAt": "2026-01-01T00:00:00.0000000+00:00",
"coverageConfirmed": false,
"coveredItemCount": 0,
"deviceId": "string",
"dualKeyWindowExpiresAt": "2026-01-01T00:00:00.0000000+00:00",
"failureReason": "string",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"introducedGeneration": "string",
"lastCheckpointAt": "2026-01-01T00:00:00.0000000+00:00",
"newGenerationEnvelopeHeld": false,
"oldGenerationItemCount": 0,
"progressPercentage": 0,
"revokedPasskeyCount": 0,
"rotatedItems": 0,
"startedAt": "2026-01-01T00:00:00.0000000+00:00",
"status": "string",
"totalItems": 0,
"trigger": "string",
"userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"schema": {
"$ref": "#/components/schemas/KeyRotationSessionResponse"
}
}
},
"description": "Checkpoint saved"
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Invalid request"
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Session not found"
},
"500": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Internal Server Error"
}
},
"summary": "Saves a checkpoint during key rotation for resume capability.",
"tags": [
"KeyRotation"
]
}
},
"/api/v1/rotation/sessions/{id}/complete": {
"post": {
"description": "The body's `newGenerationEnvelope` is the new UMK wrapped under the account's password\r\nKEK. It is held even when the answer is the retryable `coverage-incomplete`, and\r\ncompletion makes it the current envelope while revoking every passkey, recovery-phrase and\r\nduress envelope of the outgoing generation. Without one ever sent the rotation cannot\r\ncomplete. With no body the call only observes the session.\r\n\n`passkeyRewraps` (#19144) carries the new UMK re-wrapped under each passkey the user\r\nkeeps; those passkeys get a new-generation envelope instead of being revoked. Held with the\r\nenvelope across `coverage-incomplete`. A credential with no live vault-unlock envelope\r\nrefuses the call (409 `rotation-passkey-not-enrolled`) and nothing is staged.\r\n",
"operationId": "KeyRotation_CompleteRotation",
"parameters": [
{
"description": "Key rotation session ID",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/*+json": {
"example": {
"passkeyRewraps": []
},
"schema": {
"$ref": "#/components/schemas/CompleteKeyRotationRequest"
}
},
"application/json": {
"example": {
"passkeyRewraps": []
},
"schema": {
"$ref": "#/components/schemas/CompleteKeyRotationRequest"
}
},
"text/json": {
"example": {
"passkeyRewraps": []
},
"schema": {
"$ref": "#/components/schemas/CompleteKeyRotationRequest"
}
}
},
"description": "Optional body carrying the new-generation envelope"
},
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"carriedPasskeyCount": 0,
"checkpointData": "string",
"completedAt": "2026-01-01T00:00:00.0000000+00:00",
"coverageConfirmed": false,
"coveredItemCount": 0,
"deviceId": "string",
"dualKeyWindowExpiresAt": "2026-01-01T00:00:00.0000000+00:00",
"failureReason": "string",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"introducedGeneration": "string",
"lastCheckpointAt": "2026-01-01T00:00:00.0000000+00:00",
"newGenerationEnvelopeHeld": false,
"oldGenerationItemCount": 0,
"progressPercentage": 0,
"revokedPasskeyCount": 0,
"rotatedItems": 0,
"startedAt": "2026-01-01T00:00:00.0000000+00:00",
"status": "string",
"totalItems": 0,
"trigger": "string",
"userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"schema": {
"$ref": "#/components/schemas/KeyRotationSessionResponse"
}
}
},
"description": "Rotation completed"
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Invalid operation"
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Session not found"
},
"409": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "A passkey re-wrap names a credential with no live vault-unlock envelope (reason=rotation-passkey-not-enrolled, #19144); nothing changed"
},
"500": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Internal Server Error"
}
},
"summary": "Completes a key rotation session, persisting the new key generation (#19068).",
"tags": [
"KeyRotation"
]
}
},
"/api/v1/rotation/sessions/{id}/notify-devices": {
"post": {
"operationId": "KeyRotation_NotifyDevices",
"parameters": [
{
"description": "Key rotation session ID",
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/*+json": {
"example": {
"perDeviceWrappedKeyMaterial": {}
},
"schema": {
"$ref": "#/components/schemas/NotifyDevicesRequest"
}
},
"application/json": {
"example": {
"perDeviceWrappedKeyMaterial": {}
},
"schema": {
"$ref": "#/components/schemas/NotifyDevicesRequest"
}
},
"text/json": {
"example": {
"perDeviceWrappedKeyMaterial": {}
},
"schema": {
"$ref": "#/components/schemas/NotifyDevicesRequest"
}
}
},
"description": "Notify devices request with new wrapped key material"
},
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"devicesNotified": 0,
"notifiedDeviceIds": [],
"skippedDeviceFingerprints": [],
"unmatchedDeviceFingerprints": []
},
"schema": {
"$ref": "#/components/schemas/NotifyDevicesResponse"
}
}
},
"description": "Devices notified successfully"
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Invalid request"
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Session not found (or owned by another user — #9869)"
},
"500": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Internal Server Error"
}
},
"summary": "Notifies all registered devices about a completed key rotation (FR-01.016).\r\nThe initiating device calls this after completing rotation to push the new\r\nwrapped UMK to all sibling devices.",
"tags": [
"KeyRotation"
]
}
},
"/api/v1/sync/escrow/audit/export": {
"get": {
"operationId": "Escrow_ExportAudit",
"parameters": [
{
"description": "Optional scope — omit for a full-chain export.",
"in": "query",
"name": "enrolmentId",
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"description": "\"json\" (default) or \"csv\".",
"in": "query",
"name": "format",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"format": "binary",
"type": "string"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Bad Request"
},
"409": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Conflict"
}
},
"summary": "FR-01.043 — exports the tamper-evident escrow audit chain for\r\nregulator/SRE review. Gated to the `EscrowAuditExport` policy\r\n(compliance-officer or platform-admin roles). Runs the chain verifier\r\nbefore serialising: on a mismatch the endpoint returns 409 Conflict\r\nwith the failure details in a ProblemDetails body — we DO NOT ship\r\na payload that might encode tampered history without an explicit\r\n\"chain broken\" signal, since downstream consumers are likely to\r\ntreat a 200 body as authoritative.",
"tags": [
"Escrow"
]
}
},
"/api/v1/sync/escrow/enrolments": {
"post": {
"operationId": "Escrow_Enrol",
"requestBody": {
"content": {
"application/*+json": {
"example": {
"escrowKeyFingerprint": "string",
"expiresAt": "2026-01-01T00:00:00.0000000+00:00",
"jurisdiction": "string",
"shares": [],
"threshold": 0,
"totalShares": 0,
"vaultCategory": "string"
},
"schema": {
"$ref": "#/components/schemas/EnrolEakRequest"
}
},
"application/json": {
"example": {
"escrowKeyFingerprint": "string",
"expiresAt": "2026-01-01T00:00:00.0000000+00:00",
"jurisdiction": "string",
"shares": [],
"threshold": 0,
"totalShares": 0,
"vaultCategory": "string"
},
"schema": {
"$ref": "#/components/schemas/EnrolEakRequest"
}
},
"text/json": {
"example": {
"escrowKeyFingerprint": "string",
"expiresAt": "2026-01-01T00:00:00.0000000+00:00",
"jurisdiction": "string",
"shares": [],
"threshold": 0,
"totalShares": 0,
"vaultCategory": "string"
},
"schema": {
"$ref": "#/components/schemas/EnrolEakRequest"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"example": {
"createdAt": "2026-01-01T00:00:00.0000000+00:00",
"escrowKeyFingerprint": "string",
"expiresAt": "2026-01-01T00:00:00.0000000+00:00",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"isEnabled": false,
"jurisdiction": "string",
"revocationReason": "string",
"revokedAt": "2026-01-01T00:00:00.0000000+00:00",
"shares": [],
"threshold": 0,
"totalShares": 0,
"updatedAt": "2026-01-01T00:00:00.0000000+00:00",
"userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"vaultCategory": "string"
},
"schema": {
"$ref": "#/components/schemas/EakEnrolmentResponse"
}
}
},
"description": "Created"
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Bad Request"
},
"409": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Conflict"
}
},
"summary": "Creates a new EAK enrolment with its custody shares.",
"tags": [
"Escrow"
]
}
},
"/api/v1/sync/escrow/enrolments/{id}": {
"get": {
"operationId": "Escrow_GetEnrolment",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"createdAt": "2026-01-01T00:00:00.0000000+00:00",
"escrowKeyFingerprint": "string",
"expiresAt": "2026-01-01T00:00:00.0000000+00:00",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"isEnabled": false,
"jurisdiction": "string",
"revocationReason": "string",
"revokedAt": "2026-01-01T00:00:00.0000000+00:00",
"shares": [],
"threshold": 0,
"totalShares": 0,
"updatedAt": "2026-01-01T00:00:00.0000000+00:00",
"userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"vaultCategory": "string"
},
"schema": {
"$ref": "#/components/schemas/EakEnrolmentResponse"
}
}
},
"description": "OK"
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Not Found"
}
},
"summary": "Gets an EAK enrolment (without encrypted share payloads).",
"tags": [
"Escrow"
]
}
},
"/api/v1/sync/escrow/executor-rehearsal": {
"post": {
"operationId": "ExecutorRehearsal_Conduct",
"requestBody": {
"content": {
"application/*+json": {
"example": {
"depth": "string",
"enrolmentId": "string"
},
"schema": {
"$ref": "#/components/schemas/ConductExecutorRehearsalRequest"
}
},
"application/json": {
"example": {
"depth": "string",
"enrolmentId": "string"
},
"schema": {
"$ref": "#/components/schemas/ConductExecutorRehearsalRequest"
}
},
"text/json": {
"example": {
"depth": "string",
"enrolmentId": "string"
},
"schema": {
"$ref": "#/components/schemas/ConductExecutorRehearsalRequest"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"example": {
"anchorRef": "string",
"assertion": "string",
"conductedAt": "2026-01-01T00:00:00.0000000+00:00",
"dataReleased": false,
"depth": "string",
"enrolmentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"gateResults": [],
"isReady": false,
"readinessGapCount": 0,
"readinessPassCount": 0,
"runType": "string",
"simulatedActor": false,
"umkUnwrapped": false
},
"schema": {
"$ref": "#/components/schemas/ExecutorRehearsalResponse"
}
}
},
"description": "Created"
},
"400": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Bad Request"
},
"403": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"example": {
"detail": "string",
"instance": "string",
"status": 0,
"title": "string",
"type": "string"
},
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
},
"description": "Not Found"
}
},
"summary": "Conducts a non-destructive executor-release rehearsal. Returns the readiness\r\nreport + audit anchor reference — never key material.",
"tags": [
"ExecutorRehearsal"
]
}
}
},
"security": [
{
"Bearer": []
}
],
"tags": [
{
"description": "Sovereign-instance endpoints for the FR-01.093 break-glass approver\r\ndirectory (ADDENDUM-CC-061 §4). The directory is the per-Sovereign\r\nregistry of who may act as an FR-01.080 dual-control approver; the FR-01.080\r\nquorum is \"verified against the approver directory\".",
"name": "ApproverDirectory"
},
{
"description": "Authorise-only helpdesk account-recovery endpoint (CC-061 base capability for\r\nthe journey `helpdesk-assisted-account-recovery-with-identity-proofing`).",
"name": "AssistedRecovery"
},
{
"description": "Fallback-proof identity-assurance re-establishment for the\r\n`biometric-mismatch-lockout-identity-assurance-reestablishment` journey (FR-01.072,\r\ndebt-2026-07-07-010 / debt-2026-07-07-009). When a holder is locked out because their biometric\r\nno longer matches, they fall back to a recovery code (`PUT /fallback-code` enrols it);\r\n`POST /verify` checks it and mints a short-lived assurance; `POST /rebind` spends the\r\nassurance to trust the re-established device, persist its client-derived wrapped envelope\r\n(ciphertext only) and emit the FR-66.159 confirmation via the outbox.",
"name": "BiometricMismatchRecovery"
},
{
"description": "Owner-facing endpoints for the durable break-glass escrow consent ledger\r\n(FR-01.030 / FR-01.054, journey `emergency-profile-first-responder-break-glass`, gap\r\ndebt-2026-07-06-050). The consumer records, reads, exports (GDPR Art 15), re-scopes and\r\nwithdraws their emergency-escrow opt-in. Backs the essence-web consent/legal-basis card,\r\nwhich previously rendered a provided model with no durable server-side ledger.",
"name": "BreakGlassConsent"
},
{
"description": "Server-verified mobile device-integrity verdicts (FR-01.104, #17940): a device submits an App\r\nAttest attestation over an `Integrity` challenge and the verdict is recorded against its\r\nprevious one. Its own capability, not `cap.encryption.core`: written after ADR-021's origin,\r\nit must be promoted through Release Control rather than inherit that root's grandfathered GA\r\n(CAP-011b).",
"name": "DeviceIntegrity"
},
{
"description": "The second-device approval relay (FR-01.104 (c), #22240). A device whose integrity attestation\r\nfailed is refused a key-custody operation with `401 urn:essence:device-integrity:step-up-required`\r\nuntil another of the account's devices approves it; these endpoints carry the request to that device\r\nand its `X-Device-Peer-Proof` back.",
"name": "DeviceIntegrityStepUp"
},
{
"description": "This device rotates its own key-exchange key on demand (#14870 — FR-01.012/016).",
"name": "DeviceKeyRotation"
},
{
"description": "Controller for managing registered devices.",
"name": "Devices"
},
{
"description": "The platform operator's read of Global's break-glass anchor register (FR-01.040, #22573). Since #22498\r\nevery break-glass transition on a sovereign reaches Global as a hash-only anchor and is recorded in\r\n`emergency_access_anchors`; this lists them by origin sovereign and time window, or by the\r\n`sessionRef` that pairs one break-glass's phases. It returns the rows as held — tokens, never\r\nanything resolved. Reached from the admin console through `platformadmin-gateway`.",
"name": "EmergencyAccessAnchors"
},
{
"description": "Tier E-2/E-3 server-side endpoints for the CC-061 break-glass\r\nreconstruction request lifecycle (FR-01.030/033/035/037): open,\r\napprove, deny, submit-share, lifecycle fetch, complete, and the collected\r\nrelay-share submissions. Lives under `/api/v1/escrow/*`.",
"name": "EmergencyAccessRequest"
},
{
"description": "The one-tap \"Revoke now\" link on a break-glass access receipt (FR-66.117): ends the emergency\r\naccess grant it was minted for, without a session (FR-01.042 — the subject may revoke \"at any\r\ntime\").",
"name": "EmergencyAccessRevokeLink"
},
{
"description": "EPIC 1 base capability for the `wearable-emergency-responder-access` journey\r\n(FR-01.040/041, debt-2026-07-06-038): records a wearable emergency-card responder\r\nread so it is anchored to the EPIC 4 ledger AND the account holder + nominated\r\ncontacts are notified in real time. Called by the EPIC 34 responder-read surface\r\non EVERY read (NFC and QR) — there is no silent disclosure path.",
"name": "EmergencyCardRead"
},
{
"description": "Emergency Access Key (EAK) escrow endpoints (CC-061 / FR-01.030..041): enrolment\r\ncreation and the escrow audit export. The controller only orchestrates\r\ncommands/queries — all invariants (ZK boundary, k-of-n) live on the domain\r\naggregates.",
"name": "Escrow"
},
{
"description": "Tier E-2 server-side endpoints for the CC-061 Emergency Access Key\r\nenrolment lifecycle (FR-01.031/038/040): configure, status,\r\nper-enrolment fetch, revoke, and the tamper-evident audit chain. Lives\r\nunder `/api/v1/escrow/*`.",
"name": "EscrowEnrolment"
},
{
"description": "Scoped executor credential-reveal endpoints (debt-2026-07-07-007, journey\r\n`bequeath-credentials-to-executor-at-end-of-life`) — the EPIC 1 base capability over J5\r\nreconstruction that backs the bereavement reveal surface's `onReveal` / `onRevealAll`\r\ncallbacks. A donor seals credentials for their executor; when the scoped legacy-release grant\r\nfires (estate verified) the executor reveals each one, reconstructing the plaintext on their own\r\ndevice.",
"name": "ExecutorCredentialBequest"
},
{
"description": "Non-destructive executor-release rehearsal endpoint (EPIC 1 base\r\ncapability for the journey `executor-plan-pre-mortem-rehearsal-dry-run`,\r\nEPIC 18→1 seam, FR-01.008/009/045).",
"name": "ExecutorRehearsal"
},
{
"description": "Service-only form of the CC-061 authorise-only grant confirmation (#22124), read by the EPIC 7\r\norg compliance surface (`RecoveryEnrolmentGateway`).",
"name": "InternalAssistedRecoveryConfirmation"
},
{
"description": "The FR-01.104 (c) key-custody integrity decision, served to the instances that do not hold the\r\ndevice register (#22747, option (a) of #22517).",
"name": "InternalDeviceIntegrityDecision"
},
{
"description": "Service-to-service lookup of an enrolled device's PUBLIC signing key (agent-gateway AG-M10,\r\nDECISIONS AG-D16; replaces AG-D15's statement-verification endpoint).",
"name": "InternalDeviceSigningKey"
},
{
"description": "The label of the account's current key generation, alone (#22205).",
"name": "KeyGeneration"
},
{
"description": "The user's cancel of an unfinished key rotation session (FR-01.051).",
"name": "KeyRotationCancellation"
},
{
"description": "Controller for managing key rotation sessions.\r\nKey rotation allows users to re-encrypt all vault data with a new master key.",
"name": "KeyRotation"
},
{
"description": "The durable, resumable per-item DEK re-wrap an account merge needs when the decision and\r\nthe key work are separated in time (FR-01.002 / FR-01.058, debt-2026-08-26-560).",
"name": "MergeRewrap"
},
{
"description": "Controller for managing QR code pairing sessions.",
"name": "PairingSessions"
},
{
"description": "End-B of the EPIC 1 ↔ EPIC 9 `password_change_sagas` two-ended read\r\ncontract (integration-registry, FR-01.073/078). Exposes a synchronous,\r\nsingle-row, point-in-time consult of the authoritative saga-state record so\r\nEPIC 9's login surface can distinguish a genuine bad-credential failure from\r\nthe bounded `(e)→(g)` password-change transient and answer\r\n`409 password_change_in_progress` + `Retry-After` instead of a\r\ngeneric 401 (the mirror of the already-wired End-B envelope-fetch behaviour).",
"name": "PasswordChangeSaga"
},
{
"description": "EPIC 1 producer surface for the owner's additional-protection status\r\n(journey `duress-passphrase-silent-alarm-and-decoy-unlock`,\r\ndebt-2026-07-08-131). The client reports whether it has provisioned a\r\nduress/alternate passphrase and whether it has curated the backup/decoy vault;\r\nEPIC 1 records only bounded status metadata and publishes\r\n`AlternatePassphraseStatusChangedIntegrationEvent` /\r\n`BackupVaultStatusChangedIntegrationEvent` to the EPIC 9 protection-status\r\nprojection over the outbox.",
"name": "ProtectionStatus"
},
{
"description": "Shamir account-recovery sessions (FR-01.064). Owns the server-authoritative\r\nrecovery-timeout two-tier deadline (idle reaper window + absolute security\r\nceiling) for the `account-recovery-lost-devices` journey\r\n(debt-2026-07-05-010).",
"name": "RecoverySessions"
},
{
"description": "Sovereign-instance endpoints for the FR-01.033 responder-organisation break-glass\r\nescrow-holder registry (journey `emergency-profile-first-responder-break-glass`,\r\ngap debt-2026-07-06-051). Enrols an organisation as a holder that may hold a consumer\r\nbreak-glass share and credential responders of specific `ResponderClass`es, and\r\nmanages the individual responders it has credentialed.",
"name": "ResponderHolder"
},
{
"description": "Key rotations the account owes because devices were removed (FR-01.049, #16472).",
"name": "RotationObligations"
},
{
"description": "Multi-recipient shared-credential key-wrap endpoints (FR-01.097, journey\r\n`household-shared-credential-vault-role-scoped-access`, debt-2026-07-07-040) — the 76→1\r\nseam that lets a household's shared credential be decrypted by each granted member's client\r\nand re-wrapped for whoever remains on rotation / departure.",
"name": "SharedCredentialWrap"
},
{
"description": "User private-key envelope endpoints (spec 2026-07-29 user-private-key\r\nportability) — the server-side store for a user's wrapped account private-key\r\nenvelope: an opaque, client-side Argon2id password-wrapped\r\n`EncryptedMasterKey` blob (the account RSA keyset — sharing [+ signing]\r\nprivate keys — plus the password-encrypted recovery mnemonic), NOT wrapped\r\nunder a UMK-derived key. The server holds only ciphertext + (optional) IV +\r\nepoch + algo and can never unwrap it (zero-knowledge); any device that knows\r\nthe account password can unwrap the blob locally after fetching it via\r\nM:Essence.Core.MultiDeviceSync.Api.Controllers.UserPrivateKeyEnvelopeController.Get(System.Threading.CancellationToken).",
"name": "UserPrivateKeyEnvelope"
},
{
"description": "Wrapped-UMK envelope endpoints (FR-01.058/073/074/075, api-contracts.md §1b) —\r\nthe server-side store for the envelope key model. The server holds only the\r\nwrapped UMK + KEK parameters and can never unwrap the UMK (zero-knowledge).",
"name": "WrappedUmk"
}
]
}